Tenant Access - Get

Get tenant access information details without secrets.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access?api-version=2019-12-01

URI Parameters

Name In Required Type Description
accessName
path True

The identifier of the Access configuration.

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.

Responses

Name Type Description
200 OK

Tenant Access information.

Headers

  • ETag: string
Other Status Codes

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

ApiManagementGetTenantAccess

Sample Request

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

Sample Response

{
  "id": "5600b59375ff190048030003",
  "enabled": true
}

Definitions

AccessIdName

The identifier of the Access configuration.

AccessInformationContract

Tenant access information contract of the API Management service.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

AccessIdName

The identifier of the Access configuration.

Name Type Description
access
  • string

AccessInformationContract

Tenant access information contract of the API Management service.

Name Type Description
enabled
  • boolean

Determines whether direct access is enabled.

id
  • string

Identifier.

primaryKey
  • string

Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

secondaryKey
  • string

Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

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

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

error.message
  • string

Human-readable representation of the error.