Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getWorkspaceApiDiagnostic
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getWorkspaceApiDiagnostic

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the details of the Diagnostic for an API specified by its identifier.

Uses Azure REST API version 2024-06-01-preview.

Other available API versions: 2023-09-01-preview, 2024-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Using getWorkspaceApiDiagnostic

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspaceApiDiagnostic(args: GetWorkspaceApiDiagnosticArgs, opts?: InvokeOptions): Promise<GetWorkspaceApiDiagnosticResult>
function getWorkspaceApiDiagnosticOutput(args: GetWorkspaceApiDiagnosticOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceApiDiagnosticResult>
Copy
def get_workspace_api_diagnostic(api_id: Optional[str] = None,
                                 diagnostic_id: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 workspace_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetWorkspaceApiDiagnosticResult
def get_workspace_api_diagnostic_output(api_id: Optional[pulumi.Input[str]] = None,
                                 diagnostic_id: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 service_name: Optional[pulumi.Input[str]] = None,
                                 workspace_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceApiDiagnosticResult]
Copy
func LookupWorkspaceApiDiagnostic(ctx *Context, args *LookupWorkspaceApiDiagnosticArgs, opts ...InvokeOption) (*LookupWorkspaceApiDiagnosticResult, error)
func LookupWorkspaceApiDiagnosticOutput(ctx *Context, args *LookupWorkspaceApiDiagnosticOutputArgs, opts ...InvokeOption) LookupWorkspaceApiDiagnosticResultOutput
Copy

> Note: This function is named LookupWorkspaceApiDiagnostic in the Go SDK.

public static class GetWorkspaceApiDiagnostic 
{
    public static Task<GetWorkspaceApiDiagnosticResult> InvokeAsync(GetWorkspaceApiDiagnosticArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceApiDiagnosticResult> Invoke(GetWorkspaceApiDiagnosticInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceApiDiagnosticResult> getWorkspaceApiDiagnostic(GetWorkspaceApiDiagnosticArgs args, InvokeOptions options)
public static Output<GetWorkspaceApiDiagnosticResult> getWorkspaceApiDiagnostic(GetWorkspaceApiDiagnosticArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceApiDiagnostic
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
DiagnosticId
This property is required.
Changes to this property will trigger replacement.
string
Diagnostic identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
DiagnosticId
This property is required.
Changes to this property will trigger replacement.
string
Diagnostic identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API identifier. Must be unique in the current API Management service instance.
diagnosticId
This property is required.
Changes to this property will trigger replacement.
String
Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
diagnosticId
This property is required.
Changes to this property will trigger replacement.
string
Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
api_id
This property is required.
Changes to this property will trigger replacement.
str
API identifier. Must be unique in the current API Management service instance.
diagnostic_id
This property is required.
Changes to this property will trigger replacement.
str
Diagnostic identifier. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API identifier. Must be unique in the current API Management service instance.
diagnosticId
This property is required.
Changes to this property will trigger replacement.
String
Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceApiDiagnostic Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LoggerId string
Resource Id of a target logger.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AlwaysLog string
Specifies for what type of messages sampling settings should not apply.
Backend Pulumi.AzureNative.ApiManagement.Outputs.PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Backend
Frontend Pulumi.AzureNative.ApiManagement.Outputs.PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
HttpCorrelationProtocol string
Sets correlation protocol to use for Application Insights diagnostics.
LargeLanguageModel Pulumi.AzureNative.ApiManagement.Outputs.LLMDiagnosticSettingsResponse
Large Language Models diagnostic settings
LogClientIp bool
Log the ClientIP. Default is false.
Metrics bool
Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
OperationNameFormat string
The format of the Operation Name for Application Insights telemetries. Default is Name.
Sampling Pulumi.AzureNative.ApiManagement.Outputs.SamplingSettingsResponse
Sampling settings for Diagnostic.
Verbosity string
The verbosity level applied to traces emitted by trace policies.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LoggerId string
Resource Id of a target logger.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AlwaysLog string
Specifies for what type of messages sampling settings should not apply.
Backend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Backend
Frontend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
HttpCorrelationProtocol string
Sets correlation protocol to use for Application Insights diagnostics.
LargeLanguageModel LLMDiagnosticSettingsResponse
Large Language Models diagnostic settings
LogClientIp bool
Log the ClientIP. Default is false.
Metrics bool
Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
OperationNameFormat string
The format of the Operation Name for Application Insights telemetries. Default is Name.
Sampling SamplingSettingsResponse
Sampling settings for Diagnostic.
Verbosity string
The verbosity level applied to traces emitted by trace policies.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
loggerId String
Resource Id of a target logger.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
alwaysLog String
Specifies for what type of messages sampling settings should not apply.
backend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol String
Sets correlation protocol to use for Application Insights diagnostics.
largeLanguageModel LLMDiagnosticSettingsResponse
Large Language Models diagnostic settings
logClientIp Boolean
Log the ClientIP. Default is false.
metrics Boolean
Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat String
The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling SamplingSettingsResponse
Sampling settings for Diagnostic.
verbosity String
The verbosity level applied to traces emitted by trace policies.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
loggerId string
Resource Id of a target logger.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
alwaysLog string
Specifies for what type of messages sampling settings should not apply.
backend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol string
Sets correlation protocol to use for Application Insights diagnostics.
largeLanguageModel LLMDiagnosticSettingsResponse
Large Language Models diagnostic settings
logClientIp boolean
Log the ClientIP. Default is false.
metrics boolean
Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat string
The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling SamplingSettingsResponse
Sampling settings for Diagnostic.
verbosity string
The verbosity level applied to traces emitted by trace policies.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
logger_id str
Resource Id of a target logger.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
always_log str
Specifies for what type of messages sampling settings should not apply.
backend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend PipelineDiagnosticSettingsResponse
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
http_correlation_protocol str
Sets correlation protocol to use for Application Insights diagnostics.
large_language_model LLMDiagnosticSettingsResponse
Large Language Models diagnostic settings
log_client_ip bool
Log the ClientIP. Default is false.
metrics bool
Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operation_name_format str
The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling SamplingSettingsResponse
Sampling settings for Diagnostic.
verbosity str
The verbosity level applied to traces emitted by trace policies.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
loggerId String
Resource Id of a target logger.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
alwaysLog String
Specifies for what type of messages sampling settings should not apply.
backend Property Map
Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend Property Map
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol String
Sets correlation protocol to use for Application Insights diagnostics.
largeLanguageModel Property Map
Large Language Models diagnostic settings
logClientIp Boolean
Log the ClientIP. Default is false.
metrics Boolean
Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat String
The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling Property Map
Sampling settings for Diagnostic.
verbosity String
The verbosity level applied to traces emitted by trace policies.

Supporting Types

BodyDiagnosticSettingsResponse

Bytes int
Number of request body bytes to log.
Bytes int
Number of request body bytes to log.
bytes Integer
Number of request body bytes to log.
bytes number
Number of request body bytes to log.
bytes int
Number of request body bytes to log.
bytes Number
Number of request body bytes to log.

DataMaskingEntityResponse

Mode string
Data masking mode.
Value string
The name of an entity to mask (e.g. a name of a header or a query parameter).
Mode string
Data masking mode.
Value string
The name of an entity to mask (e.g. a name of a header or a query parameter).
mode String
Data masking mode.
value String
The name of an entity to mask (e.g. a name of a header or a query parameter).
mode string
Data masking mode.
value string
The name of an entity to mask (e.g. a name of a header or a query parameter).
mode str
Data masking mode.
value str
The name of an entity to mask (e.g. a name of a header or a query parameter).
mode String
Data masking mode.
value String
The name of an entity to mask (e.g. a name of a header or a query parameter).

DataMaskingResponse

Headers []DataMaskingEntityResponse
Masking settings for headers
QueryParams []DataMaskingEntityResponse
Masking settings for Url query parameters
headers List<DataMaskingEntityResponse>
Masking settings for headers
queryParams List<DataMaskingEntityResponse>
Masking settings for Url query parameters
headers DataMaskingEntityResponse[]
Masking settings for headers
queryParams DataMaskingEntityResponse[]
Masking settings for Url query parameters
headers Sequence[DataMaskingEntityResponse]
Masking settings for headers
query_params Sequence[DataMaskingEntityResponse]
Masking settings for Url query parameters
headers List<Property Map>
Masking settings for headers
queryParams List<Property Map>
Masking settings for Url query parameters

HttpMessageDiagnosticResponse

Body BodyDiagnosticSettingsResponse
Body logging settings.
DataMasking DataMaskingResponse
Data masking settings.
Headers []string
Array of HTTP Headers to log.
body BodyDiagnosticSettingsResponse
Body logging settings.
dataMasking DataMaskingResponse
Data masking settings.
headers List<String>
Array of HTTP Headers to log.
body BodyDiagnosticSettingsResponse
Body logging settings.
dataMasking DataMaskingResponse
Data masking settings.
headers string[]
Array of HTTP Headers to log.
body BodyDiagnosticSettingsResponse
Body logging settings.
data_masking DataMaskingResponse
Data masking settings.
headers Sequence[str]
Array of HTTP Headers to log.
body Property Map
Body logging settings.
dataMasking Property Map
Data masking settings.
headers List<String>
Array of HTTP Headers to log.

LLMDiagnosticSettingsResponse

Logs string
Specifies whether default diagnostic should be enabled for Large Language Models or not.
Requests Pulumi.AzureNative.ApiManagement.Inputs.LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models requests.
Responses Pulumi.AzureNative.ApiManagement.Inputs.LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models responses.
Logs string
Specifies whether default diagnostic should be enabled for Large Language Models or not.
Requests LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models requests.
Responses LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models responses.
logs String
Specifies whether default diagnostic should be enabled for Large Language Models or not.
requests LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models requests.
responses LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models responses.
logs string
Specifies whether default diagnostic should be enabled for Large Language Models or not.
requests LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models requests.
responses LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models responses.
logs str
Specifies whether default diagnostic should be enabled for Large Language Models or not.
requests LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models requests.
responses LLMMessageDiagnosticSettingsResponse
Diagnostic settings for Large Language Models responses.
logs String
Specifies whether default diagnostic should be enabled for Large Language Models or not.
requests Property Map
Diagnostic settings for Large Language Models requests.
responses Property Map
Diagnostic settings for Large Language Models responses.

LLMMessageDiagnosticSettingsResponse

MaxSizeInBytes int
Maximum size of message to logs in bytes. The default size is 32KB.
Messages string
Specifies which message should be logged. Currently there is only 'all' option.
MaxSizeInBytes int
Maximum size of message to logs in bytes. The default size is 32KB.
Messages string
Specifies which message should be logged. Currently there is only 'all' option.
maxSizeInBytes Integer
Maximum size of message to logs in bytes. The default size is 32KB.
messages String
Specifies which message should be logged. Currently there is only 'all' option.
maxSizeInBytes number
Maximum size of message to logs in bytes. The default size is 32KB.
messages string
Specifies which message should be logged. Currently there is only 'all' option.
max_size_in_bytes int
Maximum size of message to logs in bytes. The default size is 32KB.
messages str
Specifies which message should be logged. Currently there is only 'all' option.
maxSizeInBytes Number
Maximum size of message to logs in bytes. The default size is 32KB.
messages String
Specifies which message should be logged. Currently there is only 'all' option.

PipelineDiagnosticSettingsResponse

Request HttpMessageDiagnosticResponse
Diagnostic settings for request.
Response HttpMessageDiagnosticResponse
Diagnostic settings for response.
request HttpMessageDiagnosticResponse
Diagnostic settings for request.
response HttpMessageDiagnosticResponse
Diagnostic settings for response.
request HttpMessageDiagnosticResponse
Diagnostic settings for request.
response HttpMessageDiagnosticResponse
Diagnostic settings for response.
request HttpMessageDiagnosticResponse
Diagnostic settings for request.
response HttpMessageDiagnosticResponse
Diagnostic settings for response.
request Property Map
Diagnostic settings for request.
response Property Map
Diagnostic settings for response.

SamplingSettingsResponse

Percentage double
Rate of sampling for fixed-rate sampling.
SamplingType string
Sampling type.
Percentage float64
Rate of sampling for fixed-rate sampling.
SamplingType string
Sampling type.
percentage Double
Rate of sampling for fixed-rate sampling.
samplingType String
Sampling type.
percentage number
Rate of sampling for fixed-rate sampling.
samplingType string
Sampling type.
percentage float
Rate of sampling for fixed-rate sampling.
sampling_type str
Sampling type.
percentage Number
Rate of sampling for fixed-rate sampling.
samplingType String
Sampling type.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native