TenantAccess interface
Interface representing a TenantAccess.
Methods
Method Details
create(string, string, string, string, AccessInformationCreateParameters, TenantAccessCreateOptionalParams)
Update tenant access information details.
function create(resourceGroupName: string, serviceName: string, accessName: string, ifMatch: string, parameters: AccessInformationCreateParameters, options?: TenantAccessCreateOptionalParams): Promise<TenantAccessCreateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
- ifMatch
-
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.
- parameters
- AccessInformationCreateParameters
Parameters supplied to retrieve the Tenant Access Information.
- options
- TenantAccessCreateOptionalParams
The options parameters.
Returns
Promise<TenantAccessCreateResponse>
get(string, string, string, TenantAccessGetOptionalParams)
Get tenant access information details without secrets.
function get(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessGetOptionalParams): Promise<TenantAccessGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
- options
- TenantAccessGetOptionalParams
The options parameters.
Returns
Promise<TenantAccessGetResponse>
getEntityTag(string, string, string, TenantAccessGetEntityTagOptionalParams)
Tenant access metadata
function getEntityTag(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessGetEntityTagOptionalParams): Promise<TenantAccessGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
The options parameters.
Returns
Promise<TenantAccessGetEntityTagHeaders>
listByService(string, string, TenantAccessListByServiceOptionalParams)
Returns list of access infos - for Git and Management endpoints.
function listByService(resourceGroupName: string, serviceName: string, options?: TenantAccessListByServiceOptionalParams): PagedAsyncIterableIterator<AccessInformationContract, AccessInformationContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
listSecrets(string, string, string, TenantAccessListSecretsOptionalParams)
Get tenant access information details.
function listSecrets(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessListSecretsOptionalParams): Promise<TenantAccessListSecretsResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
The options parameters.
Returns
Promise<TenantAccessListSecretsResponse>
regeneratePrimaryKey(string, string, string, TenantAccessRegeneratePrimaryKeyOptionalParams)
Regenerate primary access key
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessRegeneratePrimaryKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
The options parameters.
Returns
Promise<void>
regenerateSecondaryKey(string, string, string, TenantAccessRegenerateSecondaryKeyOptionalParams)
Regenerate secondary access key
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessRegenerateSecondaryKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
The options parameters.
Returns
Promise<void>
update(string, string, string, string, AccessInformationUpdateParameters, TenantAccessUpdateOptionalParams)
Update tenant access information details.
function update(resourceGroupName: string, serviceName: string, accessName: string, ifMatch: string, parameters: AccessInformationUpdateParameters, options?: TenantAccessUpdateOptionalParams): Promise<TenantAccessUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- accessName
-
string
The identifier of the Access configuration.
- ifMatch
-
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.
- parameters
- AccessInformationUpdateParameters
Parameters supplied to retrieve the Tenant Access Information.
- options
- TenantAccessUpdateOptionalParams
The options parameters.
Returns
Promise<TenantAccessUpdateResponse>