ApiIssueImpl | @azure/arm-apimanagement

Class containing ApiIssue operations.

Hierarchy

ApiIssueImpl

Implements

ApiIssue

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiIssueImpl(client: ApiManagementClientContext): ApiIssueImpl

- Defined in operations/apiIssue.ts:36
Initialize a new instance of the class ApiIssue class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ApiIssueImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>

Implementation of ApiIssue.createOrUpdate
- Defined in operations/apiIssue.ts:196
Creates a new Issue for an API or updates an existing one.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- issueId: string
  
  Issue identifier. Must be unique in the current API Management service instance.
- parameters: IssueContract
  
  Create parameters.
- Optional options: ApiIssueCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): Promise<void>

Implementation of ApiIssue.delete
- Defined in operations/apiIssue.ts:254
Deletes the specified Issue from an API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- issueId: string
  
  Issue identifier. Must be unique in the current API Management service instance.
- 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.
- Optional options: ApiIssueDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>

Implementation of ApiIssue.get
- Defined in operations/apiIssue.ts:174
Gets the details of the Issue for an API specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- issueId: string
  
  Issue identifier. Must be unique in the current API Management service instance.
- Optional options: ApiIssueGetOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagResponse>

Implementation of ApiIssue.getEntityTag
- Defined in operations/apiIssue.ts:153
Gets the entity state (Etag) version of the Issue for an API specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- issueId: string
  
  Issue identifier. Must be unique in the current API Management service instance.
- Optional options: ApiIssueGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract>

Implementation of ApiIssue.listByService
- Defined in operations/apiIssue.ts:53
Lists all issues associated with the specified API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- Optional options: ApiIssueListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<IssueContract>

update

update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>

Implementation of ApiIssue.update
- Defined in operations/apiIssue.ts:221
Updates an existing issue for an API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- issueId: string
  
  Issue identifier. Must be unique in the current API Management service instance.
- 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: IssueUpdateContract
  
  Update parameters.
- Optional options: ApiIssueUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ApiIssueImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

parameters: IssueContract

Optional options: ApiIssueCreateOrUpdateOptionalParams

Returns Promise<ApiIssueCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

ifMatch: string

Optional options: ApiIssueDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

Optional options: ApiIssueGetOptionalParams

Returns Promise<ApiIssueGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

Optional options: ApiIssueGetEntityTagOptionalParams

Returns Promise<ApiIssueGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiIssueListByServiceOptionalParams

Returns PagedAsyncIterableIterator<IssueContract>

update

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

ifMatch: string

parameters: IssueUpdateContract

Optional options: ApiIssueUpdateOptionalParams

Returns Promise<ApiIssueUpdateResponse>