|
| 1 | +--- |
| 2 | +external help file: MicrosoftTeams-help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Grant-CsTeamsSurvivableBranchAppliancePolicy |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | + |
| 12 | +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +### Identity (Default) |
| 17 | + |
| 18 | +```powershell |
| 19 | +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>] |
| 20 | + [-MsftInternalProcessingMode <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 21 | +``` |
| 22 | + |
| 23 | +### GrantToTenant |
| 24 | + |
| 25 | +```powershell |
| 26 | +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] <String>] |
| 27 | + [-MsftInternalProcessingMode <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 28 | +``` |
| 29 | + |
| 30 | +### GrantToGroup |
| 31 | + |
| 32 | +```powershell |
| 33 | +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] <String>] |
| 34 | + [-MsftInternalProcessingMode <String>] [-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] |
| 35 | + [<CommonParameters>] |
| 36 | +``` |
| 37 | + |
| 38 | +## PARAMETERS |
| 39 | + |
| 40 | +### -Confirm |
| 41 | + |
| 42 | +Prompts you for confirmation before running the cmdlet. |
| 43 | + |
| 44 | +```yaml |
| 45 | +Type: SwitchParameter |
| 46 | +Parameter Sets: (All) |
| 47 | +Aliases: cf |
| 48 | + |
| 49 | +Required: False |
| 50 | +Position: Named |
| 51 | +Default value: None |
| 52 | +Accept pipeline input: False |
| 53 | +Accept wildcard characters: False |
| 54 | +``` |
| 55 | +
|
| 56 | +### -Global |
| 57 | +
|
| 58 | +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". |
| 59 | +
|
| 60 | +```yaml |
| 61 | +Type: SwitchParameter |
| 62 | +Parameter Sets: GrantToTenant |
| 63 | +Aliases: |
| 64 | + |
| 65 | +Required: False |
| 66 | +Position: Named |
| 67 | +Default value: None |
| 68 | +Accept pipeline input: False |
| 69 | +Accept wildcard characters: False |
| 70 | +``` |
| 71 | +
|
| 72 | +### -Group |
| 73 | +
|
| 74 | +Specifies the group used for the group policy assignment. |
| 75 | +
|
| 76 | +```yaml |
| 77 | +Type: String |
| 78 | +Parameter Sets: GrantToGroup |
| 79 | +Aliases: |
| 80 | + |
| 81 | +Required: True |
| 82 | +Position: 0 |
| 83 | +Default value: None |
| 84 | +Accept pipeline input: False |
| 85 | +Accept wildcard characters: False |
| 86 | +``` |
| 87 | +
|
| 88 | +### -Identity |
| 89 | +
|
| 90 | +The identity of the user. |
| 91 | +
|
| 92 | +```yaml |
| 93 | +Type: String |
| 94 | +Parameter Sets: Identity |
| 95 | +Aliases: |
| 96 | + |
| 97 | +Required: False |
| 98 | +Position: 0 |
| 99 | +Default value: None |
| 100 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 101 | +Accept wildcard characters: False |
| 102 | +``` |
| 103 | +
|
| 104 | +### -MsftInternalProcessingMode |
| 105 | +
|
| 106 | +For internal use only. |
| 107 | +
|
| 108 | +```yaml |
| 109 | +Type: String |
| 110 | +Parameter Sets: (All) |
| 111 | +Aliases: |
| 112 | + |
| 113 | +Required: False |
| 114 | +Position: Named |
| 115 | +Default value: None |
| 116 | +Accept pipeline input: False |
| 117 | +Accept wildcard characters: False |
| 118 | +``` |
| 119 | +
|
| 120 | +### -PassThru |
| 121 | +
|
| 122 | +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. |
| 123 | +
|
| 124 | +```yaml |
| 125 | +Type: SwitchParameter |
| 126 | +Parameter Sets: (All) |
| 127 | +Aliases: |
| 128 | + |
| 129 | +Required: False |
| 130 | +Position: Named |
| 131 | +Default value: None |
| 132 | +Accept pipeline input: False |
| 133 | +Accept wildcard characters: False |
| 134 | +``` |
| 135 | +
|
| 136 | +### -PolicyName |
| 137 | +
|
| 138 | +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. |
| 139 | +
|
| 140 | +```yaml |
| 141 | +Type: String |
| 142 | +Parameter Sets: (All) |
| 143 | +Aliases: |
| 144 | + |
| 145 | +Required: False |
| 146 | +Position: 1 |
| 147 | +Default value: None |
| 148 | +Accept pipeline input: False |
| 149 | +Accept wildcard characters: False |
| 150 | +``` |
| 151 | +
|
| 152 | +### -Rank |
| 153 | +
|
| 154 | +The rank of the policy assignment, relative to other group policy assignments for the same policy type. |
| 155 | +
|
| 156 | +```yaml |
| 157 | +Type: Int32 |
| 158 | +Parameter Sets: GrantToGroup |
| 159 | +Aliases: |
| 160 | + |
| 161 | +Required: False |
| 162 | +Position: Named |
| 163 | +Default value: None |
| 164 | +Accept pipeline input: False |
| 165 | +Accept wildcard characters: False |
| 166 | +``` |
| 167 | +
|
| 168 | +### -WhatIf |
| 169 | +
|
| 170 | +Shows what would happen if the cmdlet runs. The cmdlet is not run. |
| 171 | +
|
| 172 | +```yaml |
| 173 | +Type: SwitchParameter |
| 174 | +Parameter Sets: (All) |
| 175 | +Aliases: wi |
| 176 | + |
| 177 | +Required: False |
| 178 | +Position: Named |
| 179 | +Default value: None |
| 180 | +Accept pipeline input: False |
| 181 | +Accept wildcard characters: False |
| 182 | +``` |
| 183 | +
|
| 184 | +### CommonParameters |
| 185 | +
|
| 186 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 187 | +
|
| 188 | +## INPUTS |
| 189 | +
|
| 190 | +### System.String |
| 191 | +
|
| 192 | +## OUTPUTS |
| 193 | +
|
| 194 | +### System.Object |
| 195 | +
|
| 196 | +## NOTES |
| 197 | +
|
| 198 | +## RELATED LINKS |
0 commit comments