@datafire/azure_apimanagement_apimapis v5.0.0
@datafire/azure_apimanagement_apimapis
Client library for ApiManagementClient
Installation and Usage
npm install --save @datafire/azure_apimanagement_apimapis
let azure_apimanagement_apimapis = require('@datafire/azure_apimanagement_apimapis').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.
Actions
Api_ListByService
Lists all APIs of the API Management service instance.
azure_apimanagement_apimapis.Api_ListByService({
"resourceGroupName": "",
"serviceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - $filter
string
: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | - $top
integer
: Number of records to return. - $skip
integer
: Number of records to skip. - tags
string
: Include tags in the response. - expandApiVersionSet
boolean
: Include full ApiVersionSet resource in response - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Paged Api list representation.- nextLink
string
: Next page link if any. - value
array
: Page values.- items
object
: Api details.- properties
object
: Api Entity Properties- apiVersionSet
object
: An API Version Set contains the common configuration for a set of API Versions relating- description
string
: Description of API Version Set. - id
string
: Identifier for existing API Version Set. Omit this value to create a new Version Set. - name
string
: The display Name of the API Version Set. - versionHeaderName
string
: Name of HTTP header parameter that indicates the API Version if versioningScheme is set toheader
. - versionQueryName
string
: Name of query parameter that indicates the API Version if versioningScheme is set toquery
. - versioningScheme
string
(values: Segment, Query, Header): An value that determines where the API Version identifer will be located in a HTTP request.
- description
- displayName
string
: API name. Must be 1 to 300 characters long. - path required
string
: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - protocols
array
: Describes on which protocols the operations in this API can be invoked.- items
string
(values: http, https)
- items
- serviceUrl
string
: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - sourceApiId
string
: API identifier of the source API. - apiRevision
string
: Describes the Revision of the Api. If no value is provided, default revision 1 is created - apiRevisionDescription
string
: Description of the Api Revision. - apiVersion
string
: Indicates the Version identifier of the API if the API is versioned - apiVersionDescription
string
: Description of the Api Version. - apiVersionSetId
string
: A resource identifier for the related ApiVersionSet. - authenticationSettings
object
: API Authentication Settings.- oAuth2
object
: API OAuth2 Authentication settings details. - openid
object
: API OAuth2 Authentication settings details.
- oAuth2
- description
string
: Description of the API. May include HTML formatting tags. - isCurrent
boolean
: Indicates if API revision is current api revision. - isOnline
boolean
: Indicates if API revision is accessible via the gateway. - subscriptionKeyParameterNames
object
: Subscription key parameter names details.- header
string
: Subscription key header name. - query
string
: Subscription key query string parameter name.
- header
- subscriptionRequired
boolean
: Specifies whether an API or Product subscription is required for accessing the API. - type
string
(values: http, soap): Type of API.
- apiVersionSet
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- items
- nextLink
Api_Delete
Deletes the specified API of the API Management service instance.
azure_apimanagement_apimapis.Api_Delete({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - deleteRevisions
boolean
: Delete all revisions of the Api. - If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Api_Get
Gets the details of the API specified by its identifier.
azure_apimanagement_apimapis.Api_Get({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Api details.- properties
object
: Api Entity Properties- apiVersionSet
object
: An API Version Set contains the common configuration for a set of API Versions relating- description
string
: Description of API Version Set. - id
string
: Identifier for existing API Version Set. Omit this value to create a new Version Set. - name
string
: The display Name of the API Version Set. - versionHeaderName
string
: Name of HTTP header parameter that indicates the API Version if versioningScheme is set toheader
. - versionQueryName
string
: Name of query parameter that indicates the API Version if versioningScheme is set toquery
. - versioningScheme
string
(values: Segment, Query, Header): An value that determines where the API Version identifer will be located in a HTTP request.
- description
- displayName
string
: API name. Must be 1 to 300 characters long. - path required
string
: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - protocols
array
: Describes on which protocols the operations in this API can be invoked.- items
string
(values: http, https)
- items
- serviceUrl
string
: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - sourceApiId
string
: API identifier of the source API. - apiRevision
string
: Describes the Revision of the Api. If no value is provided, default revision 1 is created - apiRevisionDescription
string
: Description of the Api Revision. - apiVersion
string
: Indicates the Version identifier of the API if the API is versioned - apiVersionDescription
string
: Description of the Api Version. - apiVersionSetId
string
: A resource identifier for the related ApiVersionSet. - authenticationSettings
object
: API Authentication Settings.- oAuth2
object
: API OAuth2 Authentication settings details.- authorizationServerId
string
: OAuth authorization server identifier. - scope
string
: operations scope.
- authorizationServerId
- openid
object
: API OAuth2 Authentication settings details.- bearerTokenSendingMethods
array
: How to send token to the server.- items
string
(values: authorizationHeader, query): Form of an authorization grant, which the client uses to request the access token.
- items
- openidProviderId
string
: OAuth authorization server identifier.
- bearerTokenSendingMethods
- oAuth2
- description
string
: Description of the API. May include HTML formatting tags. - isCurrent
boolean
: Indicates if API revision is current api revision. - isOnline
boolean
: Indicates if API revision is accessible via the gateway. - subscriptionKeyParameterNames
object
: Subscription key parameter names details.- header
string
: Subscription key header name. - query
string
: Subscription key query string parameter name.
- header
- subscriptionRequired
boolean
: Specifies whether an API or Product subscription is required for accessing the API. - type
string
(values: http, soap): Type of API.
- apiVersionSet
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
Api_GetEntityTag
Gets the entity state (Etag) version of the API specified by its identifier.
azure_apimanagement_apimapis.Api_GetEntityTag({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Api_Update
Updates the specified API of the API Management service instance.
azure_apimanagement_apimapis.Api_Update({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"parameters": null,
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - parameters required
object
: API update contract details.- properties
object
: API update contract properties.- displayName
string
: API name. - path
string
: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - protocols
array
: Describes on which protocols the operations in this API can be invoked.- items
string
(values: http, https)
- items
- serviceUrl
string
: Absolute URL of the backend service implementing this API. - apiRevision
string
: Describes the Revision of the Api. If no value is provided, default revision 1 is created - apiRevisionDescription
string
: Description of the Api Revision. - apiVersion
string
: Indicates the Version identifier of the API if the API is versioned - apiVersionDescription
string
: Description of the Api Version. - apiVersionSetId
string
: A resource identifier for the related ApiVersionSet. - authenticationSettings
object
: API Authentication Settings.- oAuth2
object
: API OAuth2 Authentication settings details.- authorizationServerId
string
: OAuth authorization server identifier. - scope
string
: operations scope.
- authorizationServerId
- openid
object
: API OAuth2 Authentication settings details.- bearerTokenSendingMethods
array
: How to send token to the server. - openidProviderId
string
: OAuth authorization server identifier.
- bearerTokenSendingMethods
- oAuth2
- description
string
: Description of the API. May include HTML formatting tags. - isCurrent
boolean
: Indicates if API revision is current api revision. - isOnline
boolean
: Indicates if API revision is accessible via the gateway. - subscriptionKeyParameterNames
object
: Subscription key parameter names details.- header
string
: Subscription key header name. - query
string
: Subscription key query string parameter name.
- header
- subscriptionRequired
boolean
: Specifies whether an API or Product subscription is required for accessing the API. - type
string
(values: http, soap): Type of API.
- displayName
- properties
- If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
Api_CreateOrUpdate
Creates new or updates existing specified API of the API Management service instance.
azure_apimanagement_apimapis.Api_CreateOrUpdate({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - parameters required
object
: API Create or Update Parameters.- properties
object
: Api Create or Update Properties.- apiType
string
(values: http, soap): Type of Api to create. - format
string
(values: wadl-xml, wadl-link-json, swagger-json, swagger-link-json, wsdl, wsdl-link, openapi, openapi+json, openapi-link, openapi+json-link): Format of the Content in which the API is getting imported. - value
string
: Content value when Importing an API. - wsdlSelector
object
: Criteria to limit import of WSDL to a subset of the document.- wsdlEndpointName
string
: Name of endpoint(port) to import from WSDL - wsdlServiceName
string
: Name of service to import from WSDL
- wsdlEndpointName
- apiVersionSet
object
: An API Version Set contains the common configuration for a set of API Versions relating- description
string
: Description of API Version Set. - id
string
: Identifier for existing API Version Set. Omit this value to create a new Version Set. - name
string
: The display Name of the API Version Set. - versionHeaderName
string
: Name of HTTP header parameter that indicates the API Version if versioningScheme is set toheader
. - versionQueryName
string
: Name of query parameter that indicates the API Version if versioningScheme is set toquery
. - versioningScheme
string
(values: Segment, Query, Header): An value that determines where the API Version identifer will be located in a HTTP request.
- description
- displayName
string
: API name. Must be 1 to 300 characters long. - path required
string
: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - protocols
array
: Describes on which protocols the operations in this API can be invoked.- items
string
(values: http, https)
- items
- serviceUrl
string
: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - sourceApiId
string
: API identifier of the source API. - apiRevision
string
: Describes the Revision of the Api. If no value is provided, default revision 1 is created - apiRevisionDescription
string
: Description of the Api Revision. - apiVersion
string
: Indicates the Version identifier of the API if the API is versioned - apiVersionDescription
string
: Description of the Api Version. - apiVersionSetId
string
: A resource identifier for the related ApiVersionSet. - authenticationSettings
object
: API Authentication Settings.- oAuth2
object
: API OAuth2 Authentication settings details.- authorizationServerId
string
: OAuth authorization server identifier. - scope
string
: operations scope.
- authorizationServerId
- openid
object
: API OAuth2 Authentication settings details.- bearerTokenSendingMethods
array
: How to send token to the server. - openidProviderId
string
: OAuth authorization server identifier.
- bearerTokenSendingMethods
- oAuth2
- description
string
: Description of the API. May include HTML formatting tags. - isCurrent
boolean
: Indicates if API revision is current api revision. - isOnline
boolean
: Indicates if API revision is accessible via the gateway. - subscriptionKeyParameterNames
object
: Subscription key parameter names details.- header
string
: Subscription key header name. - query
string
: Subscription key query string parameter name.
- header
- subscriptionRequired
boolean
: Specifies whether an API or Product subscription is required for accessing the API. - type
string
(values: http, soap): Type of API.
- apiType
- properties
- If-Match
string
: ETag of the Entity. Not required when creating an entity, but required when updating an entity. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Api details.- properties
object
: Api Entity Properties- apiVersionSet
object
: An API Version Set contains the common configuration for a set of API Versions relating- description
string
: Description of API Version Set. - id
string
: Identifier for existing API Version Set. Omit this value to create a new Version Set. - name
string
: The display Name of the API Version Set. - versionHeaderName
string
: Name of HTTP header parameter that indicates the API Version if versioningScheme is set toheader
. - versionQueryName
string
: Name of query parameter that indicates the API Version if versioningScheme is set toquery
. - versioningScheme
string
(values: Segment, Query, Header): An value that determines where the API Version identifer will be located in a HTTP request.
- description
- displayName
string
: API name. Must be 1 to 300 characters long. - path required
string
: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - protocols
array
: Describes on which protocols the operations in this API can be invoked.- items
string
(values: http, https)
- items
- serviceUrl
string
: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - sourceApiId
string
: API identifier of the source API. - apiRevision
string
: Describes the Revision of the Api. If no value is provided, default revision 1 is created - apiRevisionDescription
string
: Description of the Api Revision. - apiVersion
string
: Indicates the Version identifier of the API if the API is versioned - apiVersionDescription
string
: Description of the Api Version. - apiVersionSetId
string
: A resource identifier for the related ApiVersionSet. - authenticationSettings
object
: API Authentication Settings.- oAuth2
object
: API OAuth2 Authentication settings details.- authorizationServerId
string
: OAuth authorization server identifier. - scope
string
: operations scope.
- authorizationServerId
- openid
object
: API OAuth2 Authentication settings details.- bearerTokenSendingMethods
array
: How to send token to the server.- items
string
(values: authorizationHeader, query): Form of an authorization grant, which the client uses to request the access token.
- items
- openidProviderId
string
: OAuth authorization server identifier.
- bearerTokenSendingMethods
- oAuth2
- description
string
: Description of the API. May include HTML formatting tags. - isCurrent
boolean
: Indicates if API revision is current api revision. - isOnline
boolean
: Indicates if API revision is accessible via the gateway. - subscriptionKeyParameterNames
object
: Subscription key parameter names details.- header
string
: Subscription key header name. - query
string
: Subscription key query string parameter name.
- header
- subscriptionRequired
boolean
: Specifies whether an API or Product subscription is required for accessing the API. - type
string
(values: http, soap): Type of API.
- apiVersionSet
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiDiagnostic_ListByService
Lists all diagnostics of an API.
azure_apimanagement_apimapis.ApiDiagnostic_ListByService({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - $filter
string
: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | - $top
integer
: Number of records to return. - $skip
integer
: Number of records to skip. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Paged Diagnostic list representation.- nextLink
string
: Next page link if any. - value
array
: Page values.- items
object
: Diagnostic details.- properties
object
: Diagnostic Entity Properties- alwaysLog
string
(values: allErrors): Specifies for what type of messages sampling settings should not apply. - backend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings. - response
object
: Http message diagnostic settings.
- request
- frontend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings. - response
object
: Http message diagnostic settings.
- request
- httpCorrelationProtocol
string
(values: None, Legacy, W3C): Sets correlation protocol to use for Application Insights diagnostics. - logClientIp
boolean
: Log the ClientIP. Default is false. - loggerId required
string
: Resource Id of a target logger. - sampling
object
: Sampling settings for Diagnostic.- percentage
number
: Rate of sampling for fixed-rate sampling. - samplingType
string
(values: fixed): Sampling type.
- percentage
- verbosity
string
(values: verbose, information, error): The verbosity level applied to traces emitted by trace policies.
- alwaysLog
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- items
- nextLink
ApiDiagnostic_Delete
Deletes the specified Diagnostic from an API.
azure_apimanagement_apimapis.ApiDiagnostic_Delete({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"diagnosticId": "",
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - diagnosticId required
string
: Diagnostic identifier. Must be unique in the current API Management service instance. - If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiDiagnostic_Get
Gets the details of the Diagnostic for an API specified by its identifier.
azure_apimanagement_apimapis.ApiDiagnostic_Get({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"diagnosticId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - diagnosticId required
string
: Diagnostic identifier. Must be unique in the current API Management service instance. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Diagnostic details.- properties
object
: Diagnostic Entity Properties- alwaysLog
string
(values: allErrors): Specifies for what type of messages sampling settings should not apply. - backend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- request
- frontend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- request
- httpCorrelationProtocol
string
(values: None, Legacy, W3C): Sets correlation protocol to use for Application Insights diagnostics. - logClientIp
boolean
: Log the ClientIP. Default is false. - loggerId required
string
: Resource Id of a target logger. - sampling
object
: Sampling settings for Diagnostic.- percentage
number
: Rate of sampling for fixed-rate sampling. - samplingType
string
(values: fixed): Sampling type.
- percentage
- verbosity
string
(values: verbose, information, error): The verbosity level applied to traces emitted by trace policies.
- alwaysLog
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiDiagnostic_GetEntityTag
Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
azure_apimanagement_apimapis.ApiDiagnostic_GetEntityTag({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"diagnosticId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - diagnosticId required
string
: Diagnostic identifier. Must be unique in the current API Management service instance. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiDiagnostic_Update
Updates the details of the Diagnostic for an API specified by its identifier.
azure_apimanagement_apimapis.ApiDiagnostic_Update({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"diagnosticId": "",
"parameters": null,
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - diagnosticId required
string
: Diagnostic identifier. Must be unique in the current API Management service instance. - parameters required
object
: Diagnostic details.- properties
object
: Diagnostic Entity Properties- alwaysLog
string
(values: allErrors): Specifies for what type of messages sampling settings should not apply. - backend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- request
- frontend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- request
- httpCorrelationProtocol
string
(values: None, Legacy, W3C): Sets correlation protocol to use for Application Insights diagnostics. - logClientIp
boolean
: Log the ClientIP. Default is false. - loggerId required
string
: Resource Id of a target logger. - sampling
object
: Sampling settings for Diagnostic.- percentage
number
: Rate of sampling for fixed-rate sampling. - samplingType
string
(values: fixed): Sampling type.
- percentage
- verbosity
string
(values: verbose, information, error): The verbosity level applied to traces emitted by trace policies.
- alwaysLog
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiDiagnostic_CreateOrUpdate
Creates a new Diagnostic for an API or updates an existing one.
azure_apimanagement_apimapis.ApiDiagnostic_CreateOrUpdate({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"diagnosticId": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - diagnosticId required
string
: Diagnostic identifier. Must be unique in the current API Management service instance. - parameters required
object
: Diagnostic details.- properties
object
: Diagnostic Entity Properties- alwaysLog
string
(values: allErrors): Specifies for what type of messages sampling settings should not apply. - backend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- request
- frontend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings. - headers
array
: Array of HTTP Headers to log.
- body
- request
- httpCorrelationProtocol
string
(values: None, Legacy, W3C): Sets correlation protocol to use for Application Insights diagnostics. - logClientIp
boolean
: Log the ClientIP. Default is false. - loggerId required
string
: Resource Id of a target logger. - sampling
object
: Sampling settings for Diagnostic.- percentage
number
: Rate of sampling for fixed-rate sampling. - samplingType
string
(values: fixed): Sampling type.
- percentage
- verbosity
string
(values: verbose, information, error): The verbosity level applied to traces emitted by trace policies.
- alwaysLog
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- If-Match
string
: ETag of the Entity. Not required when creating an entity, but required when updating an entity. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Diagnostic details.- properties
object
: Diagnostic Entity Properties- alwaysLog
string
(values: allErrors): Specifies for what type of messages sampling settings should not apply. - backend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- request
- frontend
object
: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.- request
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- response
object
: Http message diagnostic settings.- body
object
: Body logging settings.- bytes
integer
: Number of request body bytes to log.
- bytes
- headers
array
: Array of HTTP Headers to log.- items
string
- items
- body
- request
- httpCorrelationProtocol
string
(values: None, Legacy, W3C): Sets correlation protocol to use for Application Insights diagnostics. - logClientIp
boolean
: Log the ClientIP. Default is false. - loggerId required
string
: Resource Id of a target logger. - sampling
object
: Sampling settings for Diagnostic.- percentage
number
: Rate of sampling for fixed-rate sampling. - samplingType
string
(values: fixed): Sampling type.
- percentage
- verbosity
string
(values: verbose, information, error): The verbosity level applied to traces emitted by trace policies.
- alwaysLog
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiIssue_ListByService
Lists all issues associated with the specified API.
azure_apimanagement_apimapis.ApiIssue_ListByService({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - $filter
string
: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq | | - expandCommentsAttachments
boolean
: Expand the comment attachments. - $top
integer
: Number of records to return. - $skip
integer
: Number of records to skip. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Paged Issue list representation.- nextLink
string
: Next page link if any. - value
array
: Issue values.- items
object
: Issue Contract details.- properties
object
: Issue contract Properties.- description required
string
: Text describing the issue. - title required
string
: The issue title. - userId required
string
: A resource identifier for the user created the issue. - apiId
string
: A resource identifier for the API the issue was created for. - createdDate
string
: Date and time when the issue was created. - state
string
(values: proposed, open, removed, resolved, closed): Status of the issue.
- description required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- items
- nextLink
ApiIssue_Delete
Deletes the specified Issue from an API.
azure_apimanagement_apimapis.ApiIssue_Delete({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiIssue_Get
Gets the details of the Issue for an API specified by its identifier.
azure_apimanagement_apimapis.ApiIssue_Get({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - expandCommentsAttachments
boolean
: Expand the comment attachments. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Issue Contract details.- properties
object
: Issue contract Properties.- description required
string
: Text describing the issue. - title required
string
: The issue title. - userId required
string
: A resource identifier for the user created the issue. - apiId
string
: A resource identifier for the API the issue was created for. - createdDate
string
: Date and time when the issue was created. - state
string
(values: proposed, open, removed, resolved, closed): Status of the issue.
- description required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiIssue_GetEntityTag
Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
azure_apimanagement_apimapis.ApiIssue_GetEntityTag({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiIssue_Update
Updates an existing issue for an API.
azure_apimanagement_apimapis.ApiIssue_Update({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"parameters": null,
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - parameters required
object
: Issue update Parameters.- properties
object
: Issue contract Update Properties.- description
string
: Text describing the issue. - title
string
: The issue title. - userId
string
: A resource identifier for the user created the issue. - apiId
string
: A resource identifier for the API the issue was created for. - createdDate
string
: Date and time when the issue was created. - state
string
(values: proposed, open, removed, resolved, closed): Status of the issue.
- description
- properties
- If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiIssue_CreateOrUpdate
Creates a new Issue for an API or updates an existing one.
azure_apimanagement_apimapis.ApiIssue_CreateOrUpdate({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - parameters required
object
: Issue Contract details.- properties
object
: Issue contract Properties.- description required
string
: Text describing the issue. - title required
string
: The issue title. - userId required
string
: A resource identifier for the user created the issue. - apiId
string
: A resource identifier for the API the issue was created for. - createdDate
string
: Date and time when the issue was created. - state
string
(values: proposed, open, removed, resolved, closed): Status of the issue.
- description required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- If-Match
string
: ETag of the Entity. Not required when creating an entity, but required when updating an entity. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Issue Contract details.- properties
object
: Issue contract Properties.- description required
string
: Text describing the issue. - title required
string
: The issue title. - userId required
string
: A resource identifier for the user created the issue. - apiId
string
: A resource identifier for the API the issue was created for. - createdDate
string
: Date and time when the issue was created. - state
string
(values: proposed, open, removed, resolved, closed): Status of the issue.
- description required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiIssueAttachment_ListByService
Lists all attachments for the Issue associated with the specified API.
azure_apimanagement_apimapis.ApiIssueAttachment_ListByService({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - $filter
string
: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | - $top
integer
: Number of records to return. - $skip
integer
: Number of records to skip. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Paged Issue Attachment list representation.- nextLink
string
: Next page link if any. - value
array
: Issue Attachment values.- items
object
: Issue Attachment Contract details.- properties
object
: Issue Attachment contract Properties.- content required
string
: An HTTP link or Base64-encoded binary data. - contentFormat required
string
: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. - title required
string
: Filename by which the binary data will be saved.
- content required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- items
- nextLink
ApiIssueAttachment_Delete
Deletes the specified comment from an Issue.
azure_apimanagement_apimapis.ApiIssueAttachment_Delete({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"attachmentId": "",
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - attachmentId required
string
: Attachment identifier within an Issue. Must be unique in the current Issue. - If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiIssueAttachment_Get
Gets the details of the issue Attachment for an API specified by its identifier.
azure_apimanagement_apimapis.ApiIssueAttachment_Get({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"attachmentId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - attachmentId required
string
: Attachment identifier within an Issue. Must be unique in the current Issue. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Issue Attachment Contract details.- properties
object
: Issue Attachment contract Properties.- content required
string
: An HTTP link or Base64-encoded binary data. - contentFormat required
string
: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. - title required
string
: Filename by which the binary data will be saved.
- content required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiIssueAttachment_GetEntityTag
Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.
azure_apimanagement_apimapis.ApiIssueAttachment_GetEntityTag({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"attachmentId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - attachmentId required
string
: Attachment identifier within an Issue. Must be unique in the current Issue. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiIssueAttachment_CreateOrUpdate
Creates a new Attachment for the Issue in an API or updates an existing one.
azure_apimanagement_apimapis.ApiIssueAttachment_CreateOrUpdate({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"attachmentId": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - attachmentId required
string
: Attachment identifier within an Issue. Must be unique in the current Issue. - parameters required
object
: Issue Attachment Contract details.- properties
object
: Issue Attachment contract Properties.- content required
string
: An HTTP link or Base64-encoded binary data. - contentFormat required
string
: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. - title required
string
: Filename by which the binary data will be saved.
- content required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- If-Match
string
: ETag of the Entity. Not required when creating an entity, but required when updating an entity. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Issue Attachment Contract details.- properties
object
: Issue Attachment contract Properties.- content required
string
: An HTTP link or Base64-encoded binary data. - contentFormat required
string
: Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. - title required
string
: Filename by which the binary data will be saved.
- content required
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiIssueComment_ListByService
Lists all comments for the Issue associated with the specified API.
azure_apimanagement_apimapis.ApiIssueComment_ListByService({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - $filter
string
: | Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | - $top
integer
: Number of records to return. - $skip
integer
: Number of records to skip. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Paged Issue Comment list representation.- nextLink
string
: Next page link if any. - value
array
: Issue Comment values.- items
object
: Issue Comment Contract details.- properties
object
: Issue Comment contract Properties.- createdDate
string
: Date and time when the comment was created. - text required
string
: Comment text. - userId required
string
: A resource identifier for the user who left the comment.
- createdDate
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
- items
- nextLink
ApiIssueComment_Delete
Deletes the specified comment from an Issue.
azure_apimanagement_apimapis.ApiIssueComment_Delete({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"commentId": "",
"If-Match": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - commentId required
string
: Comment identifier within an Issue. Must be unique in the current Issue. - If-Match required
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. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ApiIssueComment_Get
Gets the details of the issue Comment for an API specified by its identifier.
azure_apimanagement_apimapis.ApiIssueComment_Get({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"commentId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management service. - apiId required
string
: API identifier. Must be unique in the current API Management service instance. - issueId required
string
: Issue identifier. Must be unique in the current API Management service instance. - commentId required
string
: Comment identifier within an Issue. Must be unique in the current Issue. - api-version required
string
: Version of the API to be used with the client request. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output
object
: Issue Comment Contract details.- properties
object
: Issue Comment contract Properties.- createdDate
string
: Date and time when the comment was created. - text required
string
: Comment text. - userId required
string
: A resource identifier for the user who left the comment.
- createdDate
- id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type for API Management resource.
- properties
ApiIssueComment_GetEntityTag
Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.
azure_apimanagement_apimapis.ApiIssueComment_GetEntityTag({
"resourceGroupName": "",
"serviceName": "",
"apiId": "",
"issueId": "",
"commentId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - serviceName required
string
: The name of the API Management
- resourceGroupName required