Tenant Access - List By Service

Returns list of access infos - for Git and Management endpoints.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant?$filter={$filter}&api-version=2021-08-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

serviceName
path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

$filter
query

string

Not used

Responses

Name Type Description
200 OK

AccessInformationCollection

Lists a collection of TenantAccessInfo entities.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementListTenantAccess

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant?api-version=2021-08-01

Sample response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access",
      "type": "Microsoft.ApiManagement/service/tenant",
      "name": "access",
      "properties": {
        "enabled": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

Name Description
AccessInformationCollection

Paged AccessInformation list representation.

AccessInformationContract

Tenant Settings.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

AccessInformationCollection

Paged AccessInformation list representation.

Name Type Description
count

integer

Total record count number across all pages.

nextLink

string

Next page link if any.

value

AccessInformationContract[]

Page values.

AccessInformationContract

Tenant Settings.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.enabled

boolean

Determines whether direct access is enabled.

properties.id

string

Access Information type ('access' or 'gitAccess')

properties.principalId

string

Principal (User) Identifier.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.