< Back
Set-AzureRmApiManagementTenantAccess
Post
NAME Set-AzureRmApiManagementTenantAccess
SYNOPSIS
Enables or disables tenant access.
SYNTAX
Set-AzureRmApiManagementTenantAccess -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -Enabled <Boolean> [-PassThru]
[<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementTenantAccess cmdlet enables or disables tenant access.
PARAMETERS
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Enabled <Boolean>
Specifies whether this cmdlet enables or disables tenant access. Specify a value of $True to enable or $False to disable.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns the PsApiManagementAccessInformation that this cmdlet modifies.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. 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.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation
NOTES
Example 1: Enable tenant access
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Set-AzureRmApiManagementTenantAccess -Context $apimContext -Enabled $True
This command enables tenant access in the specified context.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nantaccess
Get-AzureRmApiManagementTenantAccess
SYNOPSIS
Enables or disables tenant access.
SYNTAX
Set-AzureRmApiManagementTenantAccess -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -Enabled <Boolean> [-PassThru]
[<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementTenantAccess cmdlet enables or disables tenant access.
PARAMETERS
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Enabled <Boolean>
Specifies whether this cmdlet enables or disables tenant access. Specify a value of $True to enable or $False to disable.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns the PsApiManagementAccessInformation that this cmdlet modifies.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. 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.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation
NOTES
Example 1: Enable tenant access
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Set-AzureRmApiManagementTenantAccess -Context $apimContext -Enabled $True
This command enables tenant access in the specified context.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nantaccess
Get-AzureRmApiManagementTenantAccess