Set-​Azure​Rm​Api​Management​Tenant​Access

Enables or disables tenant access.

Syntax

Set-AzureRmApiManagementTenantAccess
   -Context <PsApiManagementContext>
   -Enabled <Boolean>
   [-PassThru]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Set-AzureRmApiManagementTenantAccess cmdlet enables or disables tenant access.

Examples

Example 1: Enable tenant access

PS C:\>Set-AzureRmApiManagementTenantAccess -Context $ApimContext -Enabled $True

This command enables tenant access in the specified context.

Required Parameters

-Context

Specifies a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Enabled

Specifies whether this cmdlet enables or disables tenant access. Specify a value of $True to enable or $False to disable.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Indicates that this cmdlet returns the PsApiManagementAccessInformation that this cmdlet modifies.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation