azure-native.peering.getPrefix
Explore with Pulumi AI
Gets an existing prefix with the specified name under the given subscription, resource group and peering service. Azure REST API version: 2022-10-01.
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:peering:getPrefix
arguments:
# arguments dictionary
The following arguments are supported:
- Peering
Service stringName The name of the peering service.
- Prefix
Name string The name of the prefix.
- Resource
Group stringName The name of the resource group.
- Expand string
The properties to be expanded.
- Peering
Service stringName The name of the peering service.
- Prefix
Name string The name of the prefix.
- Resource
Group stringName The name of the resource group.
- Expand string
The properties to be expanded.
- peering
Service StringName The name of the peering service.
- prefix
Name String The name of the prefix.
- resource
Group StringName The name of the resource group.
- expand String
The properties to be expanded.
- peering
Service stringName The name of the peering service.
- prefix
Name string The name of the prefix.
- resource
Group stringName The name of the resource group.
- expand string
The properties to be expanded.
- peering_
service_ strname The name of the peering service.
- prefix_
name str The name of the prefix.
- resource_
group_ strname The name of the resource group.
- expand str
The properties to be expanded.
- peering
Service StringName The name of the peering service.
- prefix
Name String The name of the prefix.
- resource
Group StringName The name of the resource group.
- expand String
The properties to be expanded.
getPrefix Result
The following output properties are available:
- Error
Message string The error message for validation state
- Events
List<Pulumi.
Azure Native. Peering. Outputs. Peering Service Prefix Event Response> The list of events for peering service prefix
- Id string
The ID of the resource.
- Learned
Type string The prefix learned type
- Name string
The name of the resource.
- Prefix
Validation stringState The prefix validation state
- Provisioning
State string The provisioning state of the resource.
- Type string
The type of the resource.
- Peering
Service stringPrefix Key The peering service prefix key
- Prefix string
The prefix from which your traffic originates.
- Error
Message string The error message for validation state
- Events
[]Peering
Service Prefix Event Response The list of events for peering service prefix
- Id string
The ID of the resource.
- Learned
Type string The prefix learned type
- Name string
The name of the resource.
- Prefix
Validation stringState The prefix validation state
- Provisioning
State string The provisioning state of the resource.
- Type string
The type of the resource.
- Peering
Service stringPrefix Key The peering service prefix key
- Prefix string
The prefix from which your traffic originates.
- error
Message String The error message for validation state
- events
List<Peering
Service Prefix Event Response> The list of events for peering service prefix
- id String
The ID of the resource.
- learned
Type String The prefix learned type
- name String
The name of the resource.
- prefix
Validation StringState The prefix validation state
- provisioning
State String The provisioning state of the resource.
- type String
The type of the resource.
- peering
Service StringPrefix Key The peering service prefix key
- prefix String
The prefix from which your traffic originates.
- error
Message string The error message for validation state
- events
Peering
Service Prefix Event Response[] The list of events for peering service prefix
- id string
The ID of the resource.
- learned
Type string The prefix learned type
- name string
The name of the resource.
- prefix
Validation stringState The prefix validation state
- provisioning
State string The provisioning state of the resource.
- type string
The type of the resource.
- peering
Service stringPrefix Key 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[Peering
Service Prefix Event Response] 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_ strstate The prefix validation state
- provisioning_
state str The provisioning state of the resource.
- type str
The type of the resource.
- peering_
service_ strprefix_ key The peering service prefix key
- prefix str
The prefix from which your traffic originates.
- error
Message 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.
- learned
Type String The prefix learned type
- name String
The name of the resource.
- prefix
Validation StringState The prefix validation state
- provisioning
State String The provisioning state of the resource.
- type String
The type of the resource.
- peering
Service StringPrefix Key The peering service prefix key
- prefix String
The prefix from which your traffic originates.
Supporting Types
PeeringServicePrefixEventResponse
- Event
Description string The description of the event associated with a prefix.
- Event
Level string The level of the event associated with a prefix.
- Event
Summary string The summary of the event associated with a prefix.
- Event
Timestamp string The timestamp of the event associated with a prefix.
- Event
Type string The type of the event associated with a prefix.
- Event
Description string The description of the event associated with a prefix.
- Event
Level string The level of the event associated with a prefix.
- Event
Summary string The summary of the event associated with a prefix.
- Event
Timestamp string The timestamp of the event associated with a prefix.
- Event
Type string The type of the event associated with a prefix.
- event
Description String The description of the event associated with a prefix.
- event
Level String The level of the event associated with a prefix.
- event
Summary String The summary of the event associated with a prefix.
- event
Timestamp String The timestamp of the event associated with a prefix.
- event
Type String The type of the event associated with a prefix.
- event
Description string The description of the event associated with a prefix.
- event
Level string The level of the event associated with a prefix.
- event
Summary string The summary of the event associated with a prefix.
- event
Timestamp string The timestamp of the event associated with a prefix.
- event
Type 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.
- event
Description String The description of the event associated with a prefix.
- event
Level String The level of the event associated with a prefix.
- event
Summary String The summary of the event associated with a prefix.
- event
Timestamp String The timestamp of the event associated with a prefix.
- event
Type String The type of the event associated with a prefix.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0