Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.peering.getPrefix

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getPrefix

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.

TypeScript
Python
Go
C#
Java
YAML

function getPrefix(args: GetPrefixArgs, opts?: InvokeOptions): Promise<GetPrefixResult>
function getPrefixOutput(args: GetPrefixOutputArgs, opts?: InvokeOptions): Output<GetPrefixResult>

def get_prefix(expand: Optional[str] = None,
               peering_service_name: Optional[str] = None,
               prefix_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPrefixResult
def get_prefix_output(expand: Optional[pulumi.Input[str]] = None,
               peering_service_name: Optional[pulumi.Input[str]] = None,
               prefix_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPrefixResult]

func LookupPrefix(ctx *Context, args *LookupPrefixArgs, opts ...InvokeOption) (*LookupPrefixResult, error)
func LookupPrefixOutput(ctx *Context, args *LookupPrefixOutputArgs, opts ...InvokeOption) LookupPrefixResultOutput

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

public static class GetPrefix 
{
    public static Task<GetPrefixResult> InvokeAsync(GetPrefixArgs args, InvokeOptions? opts = null)
    public static Output<GetPrefixResult> Invoke(GetPrefixInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrefixResult> getPrefix(GetPrefixArgs args, InvokeOptions options)
public static Output<GetPrefixResult> getPrefix(GetPrefixArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:peering:getPrefix
  arguments:
    # arguments dictionary

The following arguments are supported:

PeeringServiceName string: The name of the peering service.
PrefixName string: The name of the prefix.
ResourceGroupName string: The name of the resource group.
Expand string: The properties to be expanded.

PeeringServiceName string: The name of the peering service.
PrefixName string: The name of the prefix.
ResourceGroupName string: The name of the resource group.
Expand string: The properties to be expanded.

peeringServiceName String: The name of the peering service.
prefixName String: The name of the prefix.
resourceGroupName String: The name of the resource group.
expand String: The properties to be expanded.

peeringServiceName string: The name of the peering service.
prefixName string: The name of the prefix.
resourceGroupName string: The name of the resource group.
expand string: The properties to be expanded.

peering_service_name str: The name of the peering service.
prefix_name str: The name of the prefix.
resource_group_name str: The name of the resource group.
expand str: The properties to be expanded.

peeringServiceName String: The name of the peering service.
prefixName String: The name of the prefix.
resourceGroupName String: The name of the resource group.
expand String: The properties to be expanded.

getPrefix Result

The following output properties are available:

ErrorMessage string: The error message for validation state
Events List<Pulumi.AzureNative.Peering.Outputs.PeeringServicePrefixEventResponse>: The list of events for peering service prefix
Id string: The ID of the resource.
LearnedType string: The prefix learned type
Name string: The name of the resource.
PrefixValidationState string: The prefix validation state
ProvisioningState string: The provisioning state of the resource.
Type string: The type of the resource.
PeeringServicePrefixKey string: The peering service prefix key
Prefix string: The prefix from which your traffic originates.

ErrorMessage string: The error message for validation state
Events []PeeringServicePrefixEventResponse: The list of events for peering service prefix
Id string: The ID of the resource.
LearnedType string: The prefix learned type
Name string: The name of the resource.
PrefixValidationState string: The prefix validation state
ProvisioningState string: The provisioning state of the resource.
Type string: The type of the resource.
PeeringServicePrefixKey string: The peering service prefix key
Prefix string: The prefix from which your traffic originates.

errorMessage String: The error message for validation state
events List<PeeringServicePrefixEventResponse>: The list of events for peering service prefix
id String: The ID of the resource.
learnedType String: The prefix learned type
name String: The name of the resource.
prefixValidationState String: The prefix validation state
provisioningState String: The provisioning state of the resource.
type String: The type of the resource.
peeringServicePrefixKey String: The peering service prefix key
prefix String: The prefix from which your traffic originates.

errorMessage string: The error message for validation state
events PeeringServicePrefixEventResponse[]: The list of events for peering service prefix
id string: The ID of the resource.
learnedType string: The prefix learned type
name string: The name of the resource.
prefixValidationState string: The prefix validation state
provisioningState string: The provisioning state of the resource.
type string: The type of the resource.
peeringServicePrefixKey string: The peering service prefix key
prefix string: The prefix from which your traffic originates.

error_message str: The error message for validation state
events Sequence[PeeringServicePrefixEventResponse]: The list of events for peering service prefix
id str: The ID of the resource.
learned_type str: The prefix learned type
name str: The name of the resource.
prefix_validation_state str: The prefix validation state
provisioning_state str: The provisioning state of the resource.
type str: The type of the resource.
peering_service_prefix_key str: The peering service prefix key
prefix str: The prefix from which your traffic originates.

errorMessage String: The error message for validation state
events List<Property Map>: The list of events for peering service prefix
id String: The ID of the resource.
learnedType String: The prefix learned type
name String: The name of the resource.
prefixValidationState String: The prefix validation state
provisioningState String: The provisioning state of the resource.
type String: The type of the resource.
peeringServicePrefixKey String: The peering service prefix key
prefix String: The prefix from which your traffic originates.

Supporting Types

PeeringServicePrefixEventResponse

EventDescription string: The description of the event associated with a prefix.
EventLevel string: The level of the event associated with a prefix.
EventSummary string: The summary of the event associated with a prefix.
EventTimestamp string: The timestamp of the event associated with a prefix.
EventType string: The type of the event associated with a prefix.

EventDescription string: The description of the event associated with a prefix.
EventLevel string: The level of the event associated with a prefix.
EventSummary string: The summary of the event associated with a prefix.
EventTimestamp string: The timestamp of the event associated with a prefix.
EventType string: The type of the event associated with a prefix.

eventDescription String: The description of the event associated with a prefix.
eventLevel String: The level of the event associated with a prefix.
eventSummary String: The summary of the event associated with a prefix.
eventTimestamp String: The timestamp of the event associated with a prefix.
eventType String: The type of the event associated with a prefix.

eventDescription string: The description of the event associated with a prefix.
eventLevel string: The level of the event associated with a prefix.
eventSummary string: The summary of the event associated with a prefix.
eventTimestamp string: The timestamp of the event associated with a prefix.
eventType string: The type of the event associated with a prefix.

event_description str: The description of the event associated with a prefix.
event_level str: The level of the event associated with a prefix.
event_summary str: The summary of the event associated with a prefix.
event_timestamp str: The timestamp of the event associated with a prefix.
event_type str: The type of the event associated with a prefix.

eventDescription String: The description of the event associated with a prefix.
eventLevel String: The level of the event associated with a prefix.
eventSummary String: The summary of the event associated with a prefix.
eventTimestamp String: The timestamp of the event associated with a prefix.
eventType String: The type of the event associated with a prefix.

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.peering.getPrefix

On this page

On this page

Using getPrefix

getPrefix Result

Supporting Types

PeeringServicePrefixEventResponse

Package Details

On this page

On this page