Edit

Share via

Set-AzApiManagementTenantAccess

  • Reference
Module:
Az.ApiManagement

Enables or disables tenant access.

Syntax

Set-AzApiManagementTenantAccess
   -Context <PsApiManagementContext>
   -Enabled <Boolean>
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzApiManagementTenantAccess cmdlet enables or disables tenant access.

Examples

Example 1: Enable tenant access

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementTenantAccess -Context $apimContext -Enabled $True

This command enables tenant access in the specified context.

Parameters

-Context

Specifies a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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
Required:True
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
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PsApiManagementContext

SwitchParameter

Outputs

PsApiManagementAccessInformation