ApiIssueAttachment interface
Interface representing a ApiIssueAttachment.
Methods
create |
Creates a new Attachment for the Issue in an API or updates an existing one. |
delete(string, string, string, string, string, string, Api |
Deletes the specified comment from an Issue. |
get(string, string, string, string, string, Api |
Gets the details of the issue Attachment for an API specified by its identifier. |
get |
Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier. |
list |
Lists all attachments for the Issue associated with the specified API. |
Method Details
createOrUpdate(string, string, string, string, string, IssueAttachmentContract, ApiIssueAttachmentCreateOrUpdateOptionalParams)
Creates a new Attachment for the Issue in an API or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, parameters: IssueAttachmentContract, options?: ApiIssueAttachmentCreateOrUpdateOptionalParams): Promise<ApiIssueAttachmentCreateOrUpdateResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
delete(string, string, string, string, string, string, ApiIssueAttachmentDeleteOptionalParams)
Deletes the specified comment from an Issue.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, ifMatch: string, options?: ApiIssueAttachmentDeleteOptionalParams): 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.
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, ApiIssueAttachmentGetOptionalParams)
Gets the details of the issue Attachment for an API specified by its identifier.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, options?: ApiIssueAttachmentGetOptionalParams): Promise<ApiIssueAttachmentGetResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiIssueAttachmentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueAttachmentGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, attachmentId: string, options?: ApiIssueAttachmentGetEntityTagOptionalParams): Promise<ApiIssueAttachmentGetEntityTagHeaders>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
listByService(string, string, string, string, ApiIssueAttachmentListByServiceOptionalParams)
Lists all attachments for the Issue associated with the specified API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueAttachmentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueAttachmentContract, IssueAttachmentContract[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.