TenantAccess | @azure/arm-apimanagement

Interface representing a TenantAccess.

Hierarchy

TenantAccess

Implemented by

TenantAccessImpl

Index

Methods

create

create(resourceGroupName: string, serviceName: string, accessName: AccessIdName, ifMatch: string, parameters: AccessInformationCreateParameters, options?: TenantAccessCreateOptionalParams): Promise<TenantAccessCreateResponse>

- Defined in operationsInterfaces/tenantAccess.ts:80
Update tenant access information details.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  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.
- Optional options: TenantAccessCreateOptionalParams
  
  The options parameters.
Returns Promise<TenantAccessCreateResponse>

get

get(resourceGroupName: string, serviceName: string, accessName: AccessIdName, options?: TenantAccessGetOptionalParams): Promise<TenantAccessGetResponse>

- Defined in operationsInterfaces/tenantAccess.ts:64
Get tenant access information details without secrets.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  The identifier of the Access configuration.
- Optional options: TenantAccessGetOptionalParams
  
  The options parameters.
Returns Promise<TenantAccessGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, accessName: AccessIdName, options?: TenantAccessGetEntityTagOptionalParams): Promise<TenantAccessGetEntityTagResponse>

- Defined in operationsInterfaces/tenantAccess.ts:51
Tenant access metadata

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  The identifier of the Access configuration.
- Optional options: TenantAccessGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<TenantAccessGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: TenantAccessListByServiceOptionalParams): PagedAsyncIterableIterator<AccessInformationContract>

- Defined in operationsInterfaces/tenantAccess.ts:39
Returns list of access infos - for Git and Management endpoints.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: TenantAccessListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<AccessInformationContract>

listSecrets

listSecrets(resourceGroupName: string, serviceName: string, accessName: AccessIdName, options?: TenantAccessListSecretsOptionalParams): Promise<TenantAccessListSecretsResponse>

- Defined in operationsInterfaces/tenantAccess.ts:139
Get tenant access information details.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  The identifier of the Access configuration.
- Optional options: TenantAccessListSecretsOptionalParams
  
  The options parameters.
Returns Promise<TenantAccessListSecretsResponse>

regeneratePrimaryKey

regeneratePrimaryKey(resourceGroupName: string, serviceName: string, accessName: AccessIdName, options?: TenantAccessRegeneratePrimaryKeyOptionalParams): Promise<void>

- Defined in operationsInterfaces/tenantAccess.ts:113
Regenerate primary access key

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  The identifier of the Access configuration.
- Optional options: TenantAccessRegeneratePrimaryKeyOptionalParams
  
  The options parameters.
Returns Promise<void>

regenerateSecondaryKey

regenerateSecondaryKey(resourceGroupName: string, serviceName: string, accessName: AccessIdName, options?: TenantAccessRegenerateSecondaryKeyOptionalParams): Promise<void>

- Defined in operationsInterfaces/tenantAccess.ts:126
Regenerate secondary access key

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  The identifier of the Access configuration.
- Optional options: TenantAccessRegenerateSecondaryKeyOptionalParams
  
  The options parameters.
Returns Promise<void>

update

update(resourceGroupName: string, serviceName: string, accessName: AccessIdName, ifMatch: string, parameters: AccessInformationUpdateParameters, options?: TenantAccessUpdateOptionalParams): Promise<TenantAccessUpdateResponse>

- Defined in operationsInterfaces/tenantAccess.ts:98
Update tenant access information details.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- accessName: AccessIdName
  
  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.
- Optional options: TenantAccessUpdateOptionalParams
  
  The options parameters.
Returns Promise<TenantAccessUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

create

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

ifMatch: string

parameters: AccessInformationCreateParameters

Optional options: TenantAccessCreateOptionalParams

Returns Promise<TenantAccessCreateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

Optional options: TenantAccessGetOptionalParams

Returns Promise<TenantAccessGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

Optional options: TenantAccessGetEntityTagOptionalParams

Returns Promise<TenantAccessGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: TenantAccessListByServiceOptionalParams

Returns PagedAsyncIterableIterator<AccessInformationContract>

listSecrets

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

Optional options: TenantAccessListSecretsOptionalParams

Returns Promise<TenantAccessListSecretsResponse>

regeneratePrimaryKey

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

Optional options: TenantAccessRegeneratePrimaryKeyOptionalParams

Returns Promise<void>

regenerateSecondaryKey

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

Optional options: TenantAccessRegenerateSecondaryKeyOptionalParams

Returns Promise<void>

update

Parameters

resourceGroupName: string

serviceName: string

accessName: AccessIdName

ifMatch: string

parameters: AccessInformationUpdateParameters

Optional options: TenantAccessUpdateOptionalParams

Returns Promise<TenantAccessUpdateResponse>