Az.Resources
This topic displays help topics for the Azure Resource Manager Cmdlets.
Active Directory
| Add-AzADGroupMember |
Adds a user to an existing AD group. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADAppCredential |
Retrieves a list of credentials associated with an application. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADApplication |
Lists existing azure active directory applications. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADGroup |
Filters active directory groups. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADGroupMember |
Lists members of an AD group in the current tenant. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADServicePrincipal |
Filters active directory service principals. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADSpCredential |
Retrieves a list of credentials associated with a service principal. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Get-AzADUser |
Filters active directory users. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| New-AzADAppCredential |
Adds a credential to an existing application. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| New-AzADApplication |
Creates a new azure active directory application. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| New-AzADGroup |
Creates a new active directory group. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| New-AzADServicePrincipal |
Creates a new Azure active directory service principal. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| New-AzADSpCredential |
Adds a credential to an existing service principal. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| New-AzADUser |
Creates a new active directory user. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADAppCredential |
Removes a credential from an application. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADApplication |
Deletes the azure active directory application. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADGroup |
Deletes an active directory group. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADGroupMember |
Removes a user from an AD group. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADServicePrincipal |
Deletes the azure active directory service principal. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADSpCredential |
Removes a credential from a service principal. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Remove-AzADUser |
Deletes an active directory user. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Update-AzADApplication |
Updates an existing azure active directory application. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Update-AzADServicePrincipal |
Updates an existing azure active directory service principal. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
| Update-AzADUser |
Updates an existing active directory user. Warning There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell. |
Policy
| Get-AzPolicyAlias |
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 |
Gets policy assignments. |
| Get-AzPolicyDefinition |
Gets policy definitions. |
| Get-AzPolicyExemption |
Gets policy exemptions. |
| Get-AzPolicySetDefinition |
Gets policy set definitions. |
| New-AzPolicyAssignment |
Creates a policy assignment. |
| New-AzPolicyDefinition |
Creates a policy definition. |
| New-AzPolicyExemption |
Creates a policy exemption. |
| New-AzPolicySetDefinition |
Creates a policy set definition. |
| Remove-AzPolicyAssignment |
Removes a policy assignment. |
| Remove-AzPolicyDefinition |
Removes a policy definition. |
| Remove-AzPolicyExemption |
Removes a policy exemption. |
| Remove-AzPolicySetDefinition |
Removes a policy set definition. |
| Set-AzPolicyAssignment |
Modifies a policy assignment. |
| Set-AzPolicyDefinition |
Modifies a policy definition. |
| Set-AzPolicyExemption |
Modifies a policy exemption. |
| Set-AzPolicySetDefinition |
Modifies a policy set definition |
Resources
| Export-AzResourceGroup |
Captures a resource group as a template and saves it to a file. |
| Export-AzTemplateSpec |
Exports a Template Spec to the local filesystem |
| Get-AzDenyAssignment |
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. |
| Get-AzDeployment |
Get deployment |
| Get-AzDeploymentOperation |
Get deployment operation |
| Get-AzDeploymentScript |
Gets or lists deployment scripts. |
| Get-AzDeploymentScriptLog |
Gets the log of a deployment script execution. |
| Get-AzDeploymentWhatIfResult |
Gets a template What-If result for a deployment at subscription scope. |
| Get-AzLocation |
Gets all locations and the supported resource providers for each location. |
| Get-AzManagedApplication |
Gets managed applications |
| Get-AzManagedApplicationDefinition |
Gets managed application definitions |
| Get-AzManagementGroup |
Gets Management Group(s) |
| Get-AzManagementGroupDeployment |
Get deployment at a management group |
| Get-AzManagementGroupDeploymentOperation |
Get deployment operation for management group deployment |
| Get-AzManagementGroupDeploymentWhatIfResult |
Gets a template What-If result for a deployment at management group scope. |
| Get-AzProviderFeature |
Gets information about Azure provider features. |
| Get-AzProviderOperation |
Gets the operations for an Azure resource provider that are securable using Azure RBAC. |
| Get-AzResource |
Gets resources. |
| Get-AzResourceGroup |
Gets resource groups. |
| Get-AzResourceGroupDeployment |
Gets the deployments in a resource group. |
| Get-AzResourceGroupDeploymentOperation |
Gets the resource group deployment operation |
| Get-AzResourceGroupDeploymentWhatIfResult |
Gets a template What-If result for a deployment at resource group scope. |
| Get-AzResourceLock |
Gets a resource lock. |
| Get-AzResourceProvider |
Gets a resource provider. |
| Get-AzRoleAssignment |
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. |
| Get-AzRoleDefinition |
Lists all Azure RBAC roles that are available for assignment. |
| Get-AzTag |
Gets predefined Azure tags | Gets the entire set of tags on a resource or subscription. |
| Get-AzTemplateSpec |
Gets or lists Template Specs |
| Get-AzTenantDeployment |
Get deployment at tenant scope |
| Get-AzTenantDeploymentOperation |
Get deployment operation for deployment at tenant scope |
| Get-AzTenantDeploymentWhatIfResult |
Gets a template What-If result for a deployment at tenant scope. |
| Invoke-AzResourceAction |
Invokes an action on a resource. |
| Move-AzResource |
Moves a resource to a different resource group or subscription. |
| New-AzDeployment |
Create a deployment |
| New-AzManagedApplication |
Creates an Azure managed application. |
| New-AzManagedApplicationDefinition |
Creates a managed application definition. |
| New-AzManagementGroup |
Creates a Management Group |
| New-AzManagementGroupDeployment |
Create a deployment at a management group |
| New-AzManagementGroupSubscription |
Adds a Subscription to a Management Group. |
| New-AzResource |
Creates a resource. |
| New-AzResourceGroup |
Creates an Azure resource group. |
| New-AzResourceGroupDeployment |
Adds an Azure deployment to a resource group. |
| New-AzResourceLock |
Creates a resource lock. |
| New-AzRoleAssignment |
Assigns the specified RBAC role to the specified principal, at the specified scope. |
| New-AzRoleDefinition |
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-AzTag |
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 |
Creates a new Template Spec. |
| New-AzTenantDeployment |
Create a deployment at tenant scope |
| Register-AzProviderFeature |
Registers an Azure provider feature in your account. |
| Register-AzResourceProvider |
Registers a resource provider. |
| Remove-AzDeployment |
Removes a deployment and any associated operations |
| Remove-AzDeploymentScript |
Removes a deployment script and its associated resources. |
| Remove-AzManagedApplication |
Removes a managed application |
| Remove-AzManagedApplicationDefinition |
Removes a managed application definition |
| Remove-AzManagementGroup |
Removes a Management Group |
| Remove-AzManagementGroupDeployment |
Removes a deployment at a management group and any associated operations |
| Remove-AzManagementGroupSubscription |
Removes a Subscription from a Management Group. |
| Remove-AzResource |
Removes a resource. |
| Remove-AzResourceGroup |
Removes a resource group. |
| Remove-AzResourceGroupDeployment |
Removes a resource group deployment and any associated operations. |
| Remove-AzResourceLock |
Removes a resource lock. |
| Remove-AzRoleAssignment |
Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope. |
| Remove-AzRoleDefinition |
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-AzTag |
Deletes predefined Azure tags or values | Deletes the entire set of tags on a resource or subscription. |
| Remove-AzTemplateSpec |
Removes a Template Spec |
| Remove-AzTenantDeployment |
Removes a deployment at tenant scope and any associated operations |
| Save-AzDeploymentScriptLog |
Saves the log of a deployment script execution to disk. |
| Save-AzDeploymentTemplate |
Saves a deployment template to a file. |
| Save-AzManagementGroupDeploymentTemplate |
Saves a deployment template to a file. |
| Save-AzResourceGroupDeploymentTemplate |
Saves a resource group deployment template to a file. |
| Save-AzTenantDeploymentTemplate |
Saves a deployment template to a file. |
| Set-AzManagedApplication |
Updates managed application |
| Set-AzManagedApplicationDefinition |
Updates managed application definition |
| Set-AzResource |
Modifies a resource. |
| Set-AzResourceGroup |
Modifies a resource group. |
| Set-AzResourceLock |
Modifies a resource lock. |
| Set-AzRoleAssignment |
Update an existing Role Assignment. |
| Set-AzRoleDefinition |
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 |
Modifies a Template Spec. |
| Stop-AzDeployment |
Cancel a running deployment |
| Stop-AzManagementGroupDeployment |
Cancel a running deployment at a management group |
| Stop-AzResourceGroupDeployment |
Cancels a resource group deployment. |
| Stop-AzTenantDeployment |
Cancel a running deployment at tenant scope |
| Test-AzDeployment |
Validates a deployment. |
| Test-AzManagementGroupDeployment |
Validates a deployment at a management group. |
| Test-AzResourceGroupDeployment |
Validates a resource group deployment. |
| Test-AzTenantDeployment |
Validates a deployment at tenant scope. |
| Unregister-AzProviderFeature |
Unregisters an Azure provider feature in your account. |
| Unregister-AzResourceProvider |
Unregisters a resource provider. |
| Update-AzManagementGroup |
Updates a Management Group |
| Update-AzTag |
Selectively updates the set of tags on a resource or subscription. |