Microsoft Azure

Azure API Management: Apimtenant

Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.

Endpoints 14

TenantAccess

  • GETTenantAccess_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant?$filter=stringReturns list of access infos - for Git and Management endpoints.
  • GETTenantAccess_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessNameGet tenant access information details without secrets.
  • PUTTenantAccess_Create/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessNameUpdate tenant access information details.
  • HEADTenantAccess_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessNameTenant access metadata
  • PATCHTenantAccess_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessNameUpdate tenant access information details.
  • POSTTenantAccess_RegeneratePrimaryKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessName/regeneratePrimaryKeyRegenerate primary access key
  • POSTTenantAccess_RegenerateSecondaryKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessName/regenerateSecondaryKeyRegenerate secondary access key
  • POSTTenantAccess_ListSecrets/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessName/listSecretsGet tenant access information details.

TenantAccessGit

  • POSTTenantAccessGit_RegeneratePrimaryKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessName/git/regeneratePrimaryKeyRegenerate primary access key for GIT.
  • POSTTenantAccessGit_RegenerateSecondaryKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:accessName/git/regenerateSecondaryKeyRegenerate secondary access key for GIT.

TenantConfiguration

  • POSTTenantConfiguration_Deploy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:configurationName/deployThis operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to…
  • POSTTenantConfiguration_Save/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:configurationName/saveThis operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could…
  • POSTTenantConfiguration_Validate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:configurationName/validateThis operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

TenantConfigurationSyncState

  • GETTenantConfiguration_GetSyncState/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant/:configurationName/syncStateGets the status of the most recent synchronization between the configuration database and the Git repository.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
14 operations on 11 pathsPOST 8GET 3PUT 1HEAD 1PATCH 1
Main resources
TenantAccess 8TenantConfiguration 3TenantAccessGit 2TenantConfigurationSyncState 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimtenant in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apimtenant collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “TenantAccess_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/tenant?$filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apimtenant?

Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage… It is listed under Developer tools and has 14 endpoints.

Who publishes the Azure API Management: Apimtenant?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure API Management: Apimtenant?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure API Management: Apimtenant?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apimtenant have?

14 operations on 11 paths (8 POST, 3 GET, 1 PUT, 1 HEAD, 1 PATCH). The largest groups are TenantAccess, TenantConfiguration, TenantAccessGit, TenantConfigurationSyncState.

Is forking the Azure API Management: Apimtenant free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.