|
| 1 | +--- |
| 2 | +external help file: |
| 3 | +Module Name: Az.Storage |
| 4 | +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragenetworksecurityperimeterconfiguration |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Get-AzStorageNetworkSecurityPerimeterConfiguration |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Gets effective NetworkSecurityPerimeterConfiguration for association |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### List (Default) |
| 16 | +``` |
| 17 | +Get-AzStorageNetworkSecurityPerimeterConfiguration -AccountName <String> -ResourceGroupName <String> |
| 18 | + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +### Get |
| 22 | +``` |
| 23 | +Get-AzStorageNetworkSecurityPerimeterConfiguration -AccountName <String> -Name <String> |
| 24 | + -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 25 | +``` |
| 26 | + |
| 27 | +### GetViaIdentity |
| 28 | +``` |
| 29 | +Get-AzStorageNetworkSecurityPerimeterConfiguration -InputObject <IStorageIdentity> |
| 30 | + [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 31 | +``` |
| 32 | + |
| 33 | +### GetViaIdentityStorageAccount |
| 34 | +``` |
| 35 | +Get-AzStorageNetworkSecurityPerimeterConfiguration -Name <String> |
| 36 | + -StorageAccountInputObject <IStorageIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 37 | +``` |
| 38 | + |
| 39 | +## DESCRIPTION |
| 40 | +Gets effective NetworkSecurityPerimeterConfiguration for association |
| 41 | + |
| 42 | +## EXAMPLES |
| 43 | + |
| 44 | +### Example 1: Get a NetworkSecurityPerimeterConfiguration associated with a storage account |
| 45 | +```powershell |
| 46 | +Get-AzStorageNetworkSecurityPerimeterConfiguration -ResourceGroupName "nsprg" -AccountName "nspaccount" -Name "00000000-0000-0000-0000-000000000000.associationame" |
| 47 | +``` |
| 48 | + |
| 49 | +```output |
| 50 | +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/nsprg/providers/Microsoft.Storage/storageAccounts/nspaccount/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.associationame |
| 51 | +Name : 00000000-0000-0000-0000-000000000000.associationame |
| 52 | +NetworkSecurityPerimeterGuid : 00000000-0000-0000-0000-000000000000 |
| 53 | +NetworkSecurityPerimeterId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/nsprg/providers/Microsoft.Network/networkSecurityPerimeters/nspname |
| 54 | +NetworkSecurityPerimeterLocation : eastus |
| 55 | +ProfileAccessRule : {} |
| 56 | +ProfileAccessRulesVersion : 0 |
| 57 | +ProfileDiagnosticSettingsVersion : 0 |
| 58 | +ProfileEnabledLogCategory : {} |
| 59 | +ProfileName : nsptest |
| 60 | +ProvisioningIssue : |
| 61 | +ProvisioningState : Succeeded |
| 62 | +ResourceAssociationAccessMode : Learning |
| 63 | +ResourceAssociationName : associationame |
| 64 | +ResourceGroupName : nsprg |
| 65 | +SystemDataCreatedAt : |
| 66 | +SystemDataCreatedBy : |
| 67 | +SystemDataCreatedByType : |
| 68 | +SystemDataLastModifiedAt : |
| 69 | +SystemDataLastModifiedBy : |
| 70 | +SystemDataLastModifiedByType : |
| 71 | +Type : Microsoft.Storage/storageAccounts/networkSecurityPerimeterConfigurations |
| 72 | +``` |
| 73 | + |
| 74 | +This command gets a NetworkSecurityPerimeterConfiguration associated with a storage account "nspaccount" with the nspConfig Name. |
| 75 | + |
| 76 | +### Example 2: List NetworkSecurityPerimeterConfiguration associated with a storage account |
| 77 | +```powershell |
| 78 | +Get-AzStorageNetworkSecurityPerimeterConfiguration -ResourceGroupName "nsprg" -AccountName "nspaccount" |
| 79 | +``` |
| 80 | + |
| 81 | +```output |
| 82 | +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/nsprg/providers/Microsoft.Storage/storageAccounts/nspaccount/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.associationame |
| 83 | +Name : 00000000-0000-0000-0000-000000000000.associationame |
| 84 | +NetworkSecurityPerimeterGuid : 00000000-0000-0000-0000-000000000000 |
| 85 | +NetworkSecurityPerimeterId : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/nsprg/providers/Microsoft.Network/networkSecurityPerimeters/nspname |
| 86 | +NetworkSecurityPerimeterLocation : eastus |
| 87 | +ProfileAccessRule : {} |
| 88 | +ProfileAccessRulesVersion : 0 |
| 89 | +ProfileDiagnosticSettingsVersion : 0 |
| 90 | +ProfileEnabledLogCategory : {} |
| 91 | +ProfileName : nsptest |
| 92 | +ProvisioningIssue : |
| 93 | +ProvisioningState : Succeeded |
| 94 | +ResourceAssociationAccessMode : Learning |
| 95 | +ResourceAssociationName : associationame |
| 96 | +ResourceGroupName : nsprg |
| 97 | +SystemDataCreatedAt : |
| 98 | +SystemDataCreatedBy : |
| 99 | +SystemDataCreatedByType : |
| 100 | +SystemDataLastModifiedAt : |
| 101 | +SystemDataLastModifiedBy : |
| 102 | +SystemDataLastModifiedByType : |
| 103 | +Type : Microsoft.Storage/storageAccounts/networkSecurityPerimeterConfigurations |
| 104 | +``` |
| 105 | + |
| 106 | +This command lists all NetworkSecurityPerimeterConfiguration associated with a storage account "nspaccount". |
| 107 | + |
| 108 | +## PARAMETERS |
| 109 | + |
| 110 | +### -AccountName |
| 111 | +The name of the storage account within the specified resource group. |
| 112 | +Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
| 113 | + |
| 114 | +```yaml |
| 115 | +Type: System.String |
| 116 | +Parameter Sets: Get, List |
| 117 | +Aliases: |
| 118 | + |
| 119 | +Required: True |
| 120 | +Position: Named |
| 121 | +Default value: None |
| 122 | +Accept pipeline input: False |
| 123 | +Accept wildcard characters: False |
| 124 | +``` |
| 125 | +
|
| 126 | +### -DefaultProfile |
| 127 | +The DefaultProfile parameter is not functional. |
| 128 | +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. |
| 129 | +
|
| 130 | +```yaml |
| 131 | +Type: System.Management.Automation.PSObject |
| 132 | +Parameter Sets: (All) |
| 133 | +Aliases: AzureRMContext, AzureCredential |
| 134 | + |
| 135 | +Required: False |
| 136 | +Position: Named |
| 137 | +Default value: None |
| 138 | +Accept pipeline input: False |
| 139 | +Accept wildcard characters: False |
| 140 | +``` |
| 141 | +
|
| 142 | +### -InputObject |
| 143 | +Identity Parameter |
| 144 | +
|
| 145 | +```yaml |
| 146 | +Type: Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity |
| 147 | +Parameter Sets: GetViaIdentity |
| 148 | +Aliases: |
| 149 | + |
| 150 | +Required: True |
| 151 | +Position: Named |
| 152 | +Default value: None |
| 153 | +Accept pipeline input: True (ByValue) |
| 154 | +Accept wildcard characters: False |
| 155 | +``` |
| 156 | +
|
| 157 | +### -Name |
| 158 | +The name for Network Security Perimeter configuration |
| 159 | +
|
| 160 | +```yaml |
| 161 | +Type: System.String |
| 162 | +Parameter Sets: Get, GetViaIdentityStorageAccount |
| 163 | +Aliases: NetworkSecurityPerimeterConfigurationName |
| 164 | + |
| 165 | +Required: True |
| 166 | +Position: Named |
| 167 | +Default value: None |
| 168 | +Accept pipeline input: False |
| 169 | +Accept wildcard characters: False |
| 170 | +``` |
| 171 | +
|
| 172 | +### -ResourceGroupName |
| 173 | +The name of the resource group within the user's subscription. |
| 174 | +The name is case insensitive. |
| 175 | +
|
| 176 | +```yaml |
| 177 | +Type: System.String |
| 178 | +Parameter Sets: Get, List |
| 179 | +Aliases: |
| 180 | + |
| 181 | +Required: True |
| 182 | +Position: Named |
| 183 | +Default value: None |
| 184 | +Accept pipeline input: False |
| 185 | +Accept wildcard characters: False |
| 186 | +``` |
| 187 | +
|
| 188 | +### -StorageAccountInputObject |
| 189 | +Identity Parameter |
| 190 | +
|
| 191 | +```yaml |
| 192 | +Type: Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity |
| 193 | +Parameter Sets: GetViaIdentityStorageAccount |
| 194 | +Aliases: |
| 195 | + |
| 196 | +Required: True |
| 197 | +Position: Named |
| 198 | +Default value: None |
| 199 | +Accept pipeline input: True (ByValue) |
| 200 | +Accept wildcard characters: False |
| 201 | +``` |
| 202 | +
|
| 203 | +### -SubscriptionId |
| 204 | +The ID of the target subscription. |
| 205 | +
|
| 206 | +```yaml |
| 207 | +Type: System.String[] |
| 208 | +Parameter Sets: Get, List |
| 209 | +Aliases: |
| 210 | + |
| 211 | +Required: False |
| 212 | +Position: Named |
| 213 | +Default value: (Get-AzContext).Subscription.Id |
| 214 | +Accept pipeline input: False |
| 215 | +Accept wildcard characters: False |
| 216 | +``` |
| 217 | +
|
| 218 | +### CommonParameters |
| 219 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 220 | +
|
| 221 | +## INPUTS |
| 222 | +
|
| 223 | +### Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity |
| 224 | +
|
| 225 | +## OUTPUTS |
| 226 | +
|
| 227 | +### Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.INetworkSecurityPerimeterConfiguration |
| 228 | +
|
| 229 | +## NOTES |
| 230 | +
|
| 231 | +## RELATED LINKS |
| 232 | +
|
0 commit comments