ApiIssueAttachmentImpl | @azure/arm-apimanagement

Class containing ApiIssueAttachment operations.

Hierarchy

ApiIssueAttachmentImpl

Implements

ApiIssueAttachment

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiIssueAttachmentImpl(client: ApiManagementClientContext): ApiIssueAttachmentImpl

- Defined in operations/apiIssueAttachment.ts:33
Initialize a new instance of the class ApiIssueAttachment class.

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

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, parameters: IssueAttachmentContract, options?: ApiIssueAttachmentCreateOrUpdateOptionalParams): Promise<ApiIssueAttachmentCreateOrUpdateResponse>

Implementation of ApiIssueAttachment.createOrUpdate
- Defined in operations/apiIssueAttachment.ts:209
Creates a new Attachment for the Issue in 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.
- attachmentId: string
  
  Attachment identifier within an Issue. Must be unique in the current Issue.
- parameters: IssueAttachmentContract
  
  Create parameters.
- Optional options: ApiIssueAttachmentCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueAttachmentCreateOrUpdateResponse>

delete

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

Implementation of ApiIssueAttachment.delete
- Defined in operations/apiIssueAttachment.ts:243
Deletes the specified comment from an Issue.

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.
- attachmentId: string
  
  Attachment identifier within an Issue. Must be unique in the current Issue.
- 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: ApiIssueAttachmentDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, options?: ApiIssueAttachmentGetOptionalParams): Promise<ApiIssueAttachmentGetResponse>

Implementation of ApiIssueAttachment.get
- Defined in operations/apiIssueAttachment.ts:185
Gets the details of the issue Attachment 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.
- attachmentId: string
  
  Attachment identifier within an Issue. Must be unique in the current Issue.
- Optional options: ApiIssueAttachmentGetOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueAttachmentGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, options?: ApiIssueAttachmentGetEntityTagOptionalParams): Promise<ApiIssueAttachmentGetEntityTagResponse>

Implementation of ApiIssueAttachment.getEntityTag
- Defined in operations/apiIssueAttachment.ts:162
Gets the entity state (Etag) version of the issue Attachment 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.
- attachmentId: string
  
  Attachment identifier within an Issue. Must be unique in the current Issue.
- Optional options: ApiIssueAttachmentGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiIssueAttachmentGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueAttachmentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueAttachmentContract>

Implementation of ApiIssueAttachment.listByService
- Defined in operations/apiIssueAttachment.ts:51
Lists all attachments for the Issue 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.
- issueId: string
  
  Issue identifier. Must be unique in the current API Management service instance.
- Optional options: ApiIssueAttachmentListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<IssueAttachmentContract>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ApiIssueAttachmentImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

attachmentId: string

parameters: IssueAttachmentContract

Optional options: ApiIssueAttachmentCreateOrUpdateOptionalParams

Returns Promise<ApiIssueAttachmentCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

attachmentId: string

ifMatch: string

Optional options: ApiIssueAttachmentDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

attachmentId: string

Optional options: ApiIssueAttachmentGetOptionalParams

Returns Promise<ApiIssueAttachmentGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

attachmentId: string

Optional options: ApiIssueAttachmentGetEntityTagOptionalParams

Returns Promise<ApiIssueAttachmentGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

apiId: string

issueId: string

Optional options: ApiIssueAttachmentListByServiceOptionalParams

Returns PagedAsyncIterableIterator<IssueAttachmentContract>