@datafire/azure_apimanagement_apimtenant

Client library for ApiManagementClient

Installation and Usage

npm install --save @datafire/azure_apimanagement_apimtenant

let azure_apimanagement_apimtenant = require('@datafire/azure_apimanagement_apimtenant').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

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.

Actions

TenantAccess_Get

Get tenant access information details

azure_apimanagement_apimtenant.TenantAccess_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

• output object: Tenant access information contract of the API Management service.
  • enabled boolean: Determines whether direct access is enabled.
  • id string: Identifier.
  • primaryKey string: Primary access key.
  • secondaryKey string: Secondary access key.

TenantAccess_GetEntityTag

Tenant access metadata

azure_apimanagement_apimtenant.TenantAccess_GetEntityTag({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

Output schema unknown

TenantAccess_Update

Update tenant access information details.

azure_apimanagement_apimtenant.TenantAccess_Update({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "accessName": "",
  "If-Match": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required object: Tenant access information update parameters.
    • properties object: Tenant access information update parameters of the API Management service
      • enabled boolean: Determines whether direct access is enabled.
  • accessName required string (values: access): The identifier of the Access configuration.
  • If-Match required string: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

TenantAccessGit_Get

Gets the Git access configuration for the tenant.

azure_apimanagement_apimtenant.TenantAccessGit_Get({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

• output object: Tenant access information contract of the API Management service.
  • enabled boolean: Determines whether direct access is enabled.
  • id string: Identifier.
  • primaryKey string: Primary access key.
  • secondaryKey string: Secondary access key.

TenantAccessGit_RegeneratePrimaryKey

Regenerate primary access key for GIT.

azure_apimanagement_apimtenant.TenantAccessGit_RegeneratePrimaryKey({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

Output schema unknown

TenantAccessGit_RegenerateSecondaryKey

Regenerate secondary access key for GIT.

azure_apimanagement_apimtenant.TenantAccessGit_RegenerateSecondaryKey({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

Output schema unknown

TenantAccess_RegeneratePrimaryKey

Regenerate primary access key

azure_apimanagement_apimtenant.TenantAccess_RegeneratePrimaryKey({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

Output schema unknown

TenantAccess_RegenerateSecondaryKey

Regenerate secondary access key

azure_apimanagement_apimtenant.TenantAccess_RegenerateSecondaryKey({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "accessName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName required string (values: access): The identifier of the Access configuration.

Output

Output schema unknown

TenantConfiguration_Deploy

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

azure_apimanagement_apimtenant.TenantConfiguration_Deploy({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": "",
  "configurationName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required object: Deploy Tenant Configuration Contract.
    • properties object: Parameters supplied to the Deploy Configuration operation.
      • branch required string: The name of the Git branch from which the configuration is to be deployed to the configuration database.
      • force boolean: The value enforcing deleting subscriptions to products that are deleted in this update.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName required string (values: configuration): The identifier of the Git Configuration Operation.

Output

• output object: Operation Result.
  • actionLog array: This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
    • items object: Log of the entity being created, updated or deleted.
      • action string: Action like create/update/delete.
      • objectKey string: Identifier of the entity being created/updated/deleted.
      • objectType string: The type of entity contract.
  • error object: Error Body contract.
    • code string: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
    • details array: The list of invalid fields send in request, in case of validation error.
      • items object: Error Field contract.
        • code string: Property level error code.
        • message string: Human-readable representation of property-level error.
        • target string: Property name.
    • message string: Human-readable representation of the error.
  • id string: Operation result identifier.
  • resultInfo string: Optional result info.
  • started string: Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
  • status string (values: Started, InProgress, Succeeded, Failed): Status of an async operation.
  • updated string: Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

TenantConfiguration_Save

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

azure_apimanagement_apimtenant.TenantConfiguration_Save({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": "",
  "configurationName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required object: Save Tenant Configuration Contract details.
    • properties object: Parameters supplied to the Save Tenant Configuration operation.
      • branch required string: The name of the Git branch in which to commit the current configuration snapshot.
      • force boolean: The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName required string (values: configuration): The identifier of the Git Configuration Operation.

Output

• output object: Operation Result.
  • actionLog array: This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
    • items object: Log of the entity being created, updated or deleted.
      • action string: Action like create/update/delete.
      • objectKey string: Identifier of the entity being created/updated/deleted.
      • objectType string: The type of entity contract.
  • error object: Error Body contract.
    • code string: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
    • details array: The list of invalid fields send in request, in case of validation error.
      • items object: Error Field contract.
        • code string: Property level error code.
        • message string: Human-readable representation of property-level error.
        • target string: Property name.
    • message string: Human-readable representation of the error.
  • id string: Operation result identifier.
  • resultInfo string: Optional result info.
  • started string: Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
  • status string (values: Started, InProgress, Succeeded, Failed): Status of an async operation.
  • updated string: Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

TenantConfiguration_GetSyncState

Gets the status of the most recent synchronization between the configuration database and the Git repository.

azure_apimanagement_apimtenant.TenantConfiguration_GetSyncState({
  "resourceGroupName": "",
  "serviceName": "",
  "api-version": "",
  "subscriptionId": "",
  "configurationName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName required string (values: configuration): The identifier of the Git Configuration Operation.

Output

• output object: Tenant Configuration Synchronization State.
  • branch string: The name of Git branch.
  • commitId string: The latest commit Id.
  • configurationChangeDate string: The date of the latest configuration change. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
  • isExport boolean: value indicating if last sync was save (true) or deploy (false) operation.
  • isGitEnabled boolean: value indicating whether Git configuration access is enabled.
  • isSynced boolean: value indicating if last synchronization was later than the configuration change.
  • syncDate string: The date of the latest synchronization. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

TenantConfiguration_Validate

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

azure_apimanagement_apimtenant.TenantConfiguration_Validate({
  "resourceGroupName": "",
  "serviceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": "",
  "configurationName": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group.
  • serviceName required string: The name of the API Management service.
  • parameters required object: Deploy Tenant Configuration Contract.
    • properties object: Parameters supplied to the Deploy Configuration operation.
      • branch required string: The name of the Git branch from which the configuration is to be deployed to the configuration database.
      • force boolean: The value enforcing deleting subscriptions to products that are deleted in this update.
  • api-version required string: Version of the API to be used with the client request.
  • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName required string (values: configuration): The identifier of the Git Configuration Operation.

Output

• output object: Operation Result.
  • actionLog array: This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
    • items object: Log of the entity being created, updated or deleted.
      • action string: Action like create/update/delete.
      • objectKey string: Identifier of the entity being created/updated/deleted.
      • objectType string: The type of entity contract.
  • error object: Error Body contract.
    • code string: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
    • details array: The list of invalid fields send in request, in case of validation error.
      • items object: Error Field contract.
        • code string: Property level error code.
        • message string: Human-readable representation of property-level error.
        • target string: Property name.
    • message string: Human-readable representation of the error.
  • id string: Operation result identifier.
  • resultInfo string: Optional result info.
  • started string: Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
  • status string (values: Started, InProgress, Succeeded, Failed): Status of an async operation.
  • updated string: Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Definitions

This integration has no definitions