|
| 1 | +--- |
| 2 | +external help file: |
| 3 | +Module Name: Az.StorageCache |
| 4 | +online version: https://learn.microsoft.com/powershell/module/az.storagecache/clear-azstoragecachecach |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Clear-AzStorageCacheCach |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Tells a cache to write all dirty data to the Storage Target(s). |
| 12 | +During the flush, clients will see errors returned until the flush is complete. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +### Flush (Default) |
| 17 | +``` |
| 18 | +Clear-AzStorageCacheCach -EName <String> -ResourceGroupName <String> [-SubscriptionId <String>] |
| 19 | + [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] |
| 20 | +``` |
| 21 | + |
| 22 | +### FlushViaIdentity |
| 23 | +``` |
| 24 | +Clear-AzStorageCacheCach -InputObject <IStorageCacheIdentity> [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] |
| 25 | + [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] |
| 26 | +``` |
| 27 | + |
| 28 | +## DESCRIPTION |
| 29 | +Tells a cache to write all dirty data to the Storage Target(s). |
| 30 | +During the flush, clients will see errors returned until the flush is complete. |
| 31 | + |
| 32 | +## EXAMPLES |
| 33 | + |
| 34 | +The HPC Cache service is being deprecated. |
| 35 | + |
| 36 | +## PARAMETERS |
| 37 | + |
| 38 | +### -AsJob |
| 39 | +Run the command as a job |
| 40 | + |
| 41 | +```yaml |
| 42 | +Type: System.Management.Automation.SwitchParameter |
| 43 | +Parameter Sets: (All) |
| 44 | +Aliases: |
| 45 | + |
| 46 | +Required: False |
| 47 | +Position: Named |
| 48 | +Default value: None |
| 49 | +Accept pipeline input: False |
| 50 | +Accept wildcard characters: False |
| 51 | +``` |
| 52 | +
|
| 53 | +### -DefaultProfile |
| 54 | +The DefaultProfile parameter is not functional. |
| 55 | +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. |
| 56 | +
|
| 57 | +```yaml |
| 58 | +Type: System.Management.Automation.PSObject |
| 59 | +Parameter Sets: (All) |
| 60 | +Aliases: AzureRMContext, AzureCredential |
| 61 | + |
| 62 | +Required: False |
| 63 | +Position: Named |
| 64 | +Default value: None |
| 65 | +Accept pipeline input: False |
| 66 | +Accept wildcard characters: False |
| 67 | +``` |
| 68 | +
|
| 69 | +### -EName |
| 70 | +Name of cache. |
| 71 | +Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. |
| 72 | +
|
| 73 | +```yaml |
| 74 | +Type: System.String |
| 75 | +Parameter Sets: Flush |
| 76 | +Aliases: CacheName |
| 77 | + |
| 78 | +Required: True |
| 79 | +Position: Named |
| 80 | +Default value: None |
| 81 | +Accept pipeline input: False |
| 82 | +Accept wildcard characters: False |
| 83 | +``` |
| 84 | +
|
| 85 | +### -InputObject |
| 86 | +Identity Parameter |
| 87 | +
|
| 88 | +```yaml |
| 89 | +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageCache.Models.IStorageCacheIdentity |
| 90 | +Parameter Sets: FlushViaIdentity |
| 91 | +Aliases: |
| 92 | + |
| 93 | +Required: True |
| 94 | +Position: Named |
| 95 | +Default value: None |
| 96 | +Accept pipeline input: True (ByValue) |
| 97 | +Accept wildcard characters: False |
| 98 | +``` |
| 99 | +
|
| 100 | +### -NoWait |
| 101 | +Run the command asynchronously |
| 102 | +
|
| 103 | +```yaml |
| 104 | +Type: System.Management.Automation.SwitchParameter |
| 105 | +Parameter Sets: (All) |
| 106 | +Aliases: |
| 107 | + |
| 108 | +Required: False |
| 109 | +Position: Named |
| 110 | +Default value: None |
| 111 | +Accept pipeline input: False |
| 112 | +Accept wildcard characters: False |
| 113 | +``` |
| 114 | +
|
| 115 | +### -PassThru |
| 116 | +Returns true when the command succeeds |
| 117 | +
|
| 118 | +```yaml |
| 119 | +Type: System.Management.Automation.SwitchParameter |
| 120 | +Parameter Sets: (All) |
| 121 | +Aliases: |
| 122 | + |
| 123 | +Required: False |
| 124 | +Position: Named |
| 125 | +Default value: None |
| 126 | +Accept pipeline input: False |
| 127 | +Accept wildcard characters: False |
| 128 | +``` |
| 129 | +
|
| 130 | +### -ResourceGroupName |
| 131 | +The name of the resource group. |
| 132 | +The name is case insensitive. |
| 133 | +
|
| 134 | +```yaml |
| 135 | +Type: System.String |
| 136 | +Parameter Sets: Flush |
| 137 | +Aliases: |
| 138 | + |
| 139 | +Required: True |
| 140 | +Position: Named |
| 141 | +Default value: None |
| 142 | +Accept pipeline input: False |
| 143 | +Accept wildcard characters: False |
| 144 | +``` |
| 145 | +
|
| 146 | +### -SubscriptionId |
| 147 | +The ID of the target subscription. |
| 148 | +
|
| 149 | +```yaml |
| 150 | +Type: System.String |
| 151 | +Parameter Sets: Flush |
| 152 | +Aliases: |
| 153 | + |
| 154 | +Required: False |
| 155 | +Position: Named |
| 156 | +Default value: (Get-AzContext).Subscription.Id |
| 157 | +Accept pipeline input: False |
| 158 | +Accept wildcard characters: False |
| 159 | +``` |
| 160 | +
|
| 161 | +### -Confirm |
| 162 | +Prompts you for confirmation before running the cmdlet. |
| 163 | +
|
| 164 | +```yaml |
| 165 | +Type: System.Management.Automation.SwitchParameter |
| 166 | +Parameter Sets: (All) |
| 167 | +Aliases: cf |
| 168 | + |
| 169 | +Required: False |
| 170 | +Position: Named |
| 171 | +Default value: None |
| 172 | +Accept pipeline input: False |
| 173 | +Accept wildcard characters: False |
| 174 | +``` |
| 175 | +
|
| 176 | +### -WhatIf |
| 177 | +Shows what would happen if the cmdlet runs. |
| 178 | +The cmdlet is not run. |
| 179 | +
|
| 180 | +```yaml |
| 181 | +Type: System.Management.Automation.SwitchParameter |
| 182 | +Parameter Sets: (All) |
| 183 | +Aliases: wi |
| 184 | + |
| 185 | +Required: False |
| 186 | +Position: Named |
| 187 | +Default value: None |
| 188 | +Accept pipeline input: False |
| 189 | +Accept wildcard characters: False |
| 190 | +``` |
| 191 | +
|
| 192 | +### CommonParameters |
| 193 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 194 | +
|
| 195 | +## INPUTS |
| 196 | +
|
| 197 | +### Microsoft.Azure.PowerShell.Cmdlets.StorageCache.Models.IStorageCacheIdentity |
| 198 | +
|
| 199 | +## OUTPUTS |
| 200 | +
|
| 201 | +### System.Boolean |
| 202 | +
|
| 203 | +## NOTES |
| 204 | +
|
| 205 | +## RELATED LINKS |
| 206 | +
|
0 commit comments