Edit

Share via

Get-AzApiManagementTenantAccess

  • Reference
Module:
Az.ApiManagement

Gets the access configuration for a tenant.

Syntax

Get-AzApiManagementTenantAccess
   -Context <PsApiManagementContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzApiManagementTenantAccess cmdlet gets the tenant access configuration for a tenant. Keys will not be included into result details. To get client secret, use Get-AzApiManagementTenantAccessSecret.

Examples

Example 1: Get tenant access configuration

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementTenantAccess -Context $apimContext

This command gets the tenant access configuration for 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

Inputs

PsApiManagementContext

Outputs

PsApiManagementAccessInformation