This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi
azure-native.apimanagement.getDiagnostic
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi
Gets the details of the Diagnostic specified by its identifier. Azure REST API version: 2022-08-01.
Other available API versions: 2018-01-01, 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Using getDiagnostic
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 getDiagnostic(args: GetDiagnosticArgs, opts?: InvokeOptions): Promise<GetDiagnosticResult>
function getDiagnosticOutput(args: GetDiagnosticOutputArgs, opts?: InvokeOptions): Output<GetDiagnosticResult>
def get_diagnostic(diagnostic_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDiagnosticResult
def get_diagnostic_output(diagnostic_id: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDiagnosticResult]
func LookupDiagnostic(ctx *Context, args *LookupDiagnosticArgs, opts ...InvokeOption) (*LookupDiagnosticResult, error)
func LookupDiagnosticOutput(ctx *Context, args *LookupDiagnosticOutputArgs, opts ...InvokeOption) LookupDiagnosticResultOutput
> Note: This function is named LookupDiagnostic
in the Go SDK.
public static class GetDiagnostic
{
public static Task<GetDiagnosticResult> InvokeAsync(GetDiagnosticArgs args, InvokeOptions? opts = null)
public static Output<GetDiagnosticResult> Invoke(GetDiagnosticInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDiagnosticResult> getDiagnostic(GetDiagnosticArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:apimanagement:getDiagnostic
arguments:
# arguments dictionary
The following arguments are supported:
- Diagnostic
Id string - Diagnostic identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Diagnostic
Id string - Diagnostic identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- diagnostic
Id String - Diagnostic identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- diagnostic
Id string - Diagnostic identifier. Must be unique in the current API Management service instance.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- diagnostic_
id str - Diagnostic identifier. Must be unique in the current API Management service instance.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- diagnostic
Id String - Diagnostic identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
getDiagnostic Result
The following output properties are available:
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Logger
Id 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"
- Always
Log string - Specifies for what type of messages sampling settings should not apply.
- Backend
Pulumi.
Azure Native. Api Management. Outputs. Pipeline Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Backend
- Frontend
Pulumi.
Azure Native. Api Management. Outputs. Pipeline Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
- Http
Correlation stringProtocol - Sets correlation protocol to use for Application Insights diagnostics.
- Log
Client boolIp - Log the ClientIP. Default is false.
- Metrics bool
- Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
- Operation
Name stringFormat - The format of the Operation Name for Application Insights telemetries. Default is Name.
- Sampling
Pulumi.
Azure Native. Api Management. Outputs. Sampling Settings Response - Sampling settings for Diagnostic.
- Verbosity string
- The verbosity level applied to traces emitted by trace policies.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Logger
Id 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"
- Always
Log string - Specifies for what type of messages sampling settings should not apply.
- Backend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Backend
- Frontend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
- Http
Correlation stringProtocol - Sets correlation protocol to use for Application Insights diagnostics.
- Log
Client boolIp - Log the ClientIP. Default is false.
- Metrics bool
- Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
- Operation
Name stringFormat - The format of the Operation Name for Application Insights telemetries. Default is Name.
- Sampling
Sampling
Settings Response - Sampling settings for Diagnostic.
- Verbosity string
- The verbosity level applied to traces emitted by trace policies.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- logger
Id 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"
- always
Log String - Specifies for what type of messages sampling settings should not apply.
- backend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Backend
- frontend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
- http
Correlation StringProtocol - Sets correlation protocol to use for Application Insights diagnostics.
- log
Client BooleanIp - Log the ClientIP. Default is false.
- metrics Boolean
- Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
- operation
Name StringFormat - The format of the Operation Name for Application Insights telemetries. Default is Name.
- sampling
Sampling
Settings Response - Sampling settings for Diagnostic.
- verbosity String
- The verbosity level applied to traces emitted by trace policies.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- logger
Id 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"
- always
Log string - Specifies for what type of messages sampling settings should not apply.
- backend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Backend
- frontend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
- http
Correlation stringProtocol - Sets correlation protocol to use for Application Insights diagnostics.
- log
Client booleanIp - Log the ClientIP. Default is false.
- metrics boolean
- Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
- operation
Name stringFormat - The format of the Operation Name for Application Insights telemetries. Default is Name.
- sampling
Sampling
Settings Response - Sampling settings for Diagnostic.
- verbosity string
- The verbosity level applied to traces emitted by trace policies.
- 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
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Backend
- frontend
Pipeline
Diagnostic Settings Response - Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
- http_
correlation_ strprotocol - Sets correlation protocol to use for Application Insights diagnostics.
- log_
client_ boolip - Log the ClientIP. Default is false.
- metrics bool
- Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
- operation_
name_ strformat - The format of the Operation Name for Application Insights telemetries. Default is Name.
- sampling
Sampling
Settings Response - Sampling settings for Diagnostic.
- verbosity str
- The verbosity level applied to traces emitted by trace policies.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- logger
Id 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"
- always
Log 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.
- http
Correlation StringProtocol - Sets correlation protocol to use for Application Insights diagnostics.
- log
Client BooleanIp - Log the ClientIP. Default is false.
- metrics Boolean
- Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
- operation
Name StringFormat - 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
DataMaskingResponse
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Data Masking Entity Response> - Masking settings for headers
- Query
Params List<Pulumi.Azure Native. Api Management. Inputs. Data Masking Entity Response> - Masking settings for Url query parameters
- Headers
[]Data
Masking Entity Response - Masking settings for headers
- Query
Params []DataMasking Entity Response - Masking settings for Url query parameters
- headers
List<Data
Masking Entity Response> - Masking settings for headers
- query
Params List<DataMasking Entity Response> - Masking settings for Url query parameters
- headers
Data
Masking Entity Response[] - Masking settings for headers
- query
Params DataMasking Entity Response[] - Masking settings for Url query parameters
- headers
Sequence[Data
Masking Entity Response] - Masking settings for headers
- query_
params Sequence[DataMasking Entity Response] - Masking settings for Url query parameters
- headers List<Property Map>
- Masking settings for headers
- query
Params List<Property Map> - Masking settings for Url query parameters
HttpMessageDiagnosticResponse
- Body
Pulumi.
Azure Native. Api Management. Inputs. Body Diagnostic Settings Response - Body logging settings.
- Data
Masking Pulumi.Azure Native. Api Management. Inputs. Data Masking Response - Data masking settings.
- Headers List<string>
- Array of HTTP Headers to log.
- Body
Body
Diagnostic Settings Response - Body logging settings.
- Data
Masking DataMasking Response - Data masking settings.
- Headers []string
- Array of HTTP Headers to log.
- body
Body
Diagnostic Settings Response - Body logging settings.
- data
Masking DataMasking Response - Data masking settings.
- headers List<String>
- Array of HTTP Headers to log.
- body
Body
Diagnostic Settings Response - Body logging settings.
- data
Masking DataMasking Response - Data masking settings.
- headers string[]
- Array of HTTP Headers to log.
- body
Body
Diagnostic Settings Response - Body logging settings.
- data_
masking DataMasking Response - Data masking settings.
- headers Sequence[str]
- Array of HTTP Headers to log.
- body Property Map
- Body logging settings.
- data
Masking Property Map - Data masking settings.
- headers List<String>
- Array of HTTP Headers to log.
PipelineDiagnosticSettingsResponse
- Request
Pulumi.
Azure Native. Api Management. Inputs. Http Message Diagnostic Response - Diagnostic settings for request.
- Response
Pulumi.
Azure Native. Api Management. Inputs. Http Message Diagnostic Response - Diagnostic settings for response.
- Request
Http
Message Diagnostic Response - Diagnostic settings for request.
- Response
Http
Message Diagnostic Response - Diagnostic settings for response.
- request
Http
Message Diagnostic Response - Diagnostic settings for request.
- response
Http
Message Diagnostic Response - Diagnostic settings for response.
- request
Http
Message Diagnostic Response - Diagnostic settings for request.
- response
Http
Message Diagnostic Response - Diagnostic settings for response.
- request
Http
Message Diagnostic Response - Diagnostic settings for request.
- response
Http
Message Diagnostic Response - 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.
- Sampling
Type string - Sampling type.
- Percentage float64
- Rate of sampling for fixed-rate sampling.
- Sampling
Type string - Sampling type.
- percentage Double
- Rate of sampling for fixed-rate sampling.
- sampling
Type String - Sampling type.
- percentage number
- Rate of sampling for fixed-rate sampling.
- sampling
Type 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.
- sampling
Type 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 v1 docs if using the v1 version of this package.
Azure Native v2.76.0 published on Friday, Dec 6, 2024 by Pulumi