Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. peering
  5. getPeeringService
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.7.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.peering.getPeeringService

Explore with Pulumi AI

azure-native logo
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.7.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets an existing peering service with the specified name under the given subscription and resource group.

    Uses Azure REST API version 2022-10-01.

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

    Using getPeeringService

    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 getPeeringService(args: GetPeeringServiceArgs, opts?: InvokeOptions): Promise<GetPeeringServiceResult>
function getPeeringServiceOutput(args: GetPeeringServiceOutputArgs, opts?: InvokeOptions): Output<GetPeeringServiceResult>
    def get_peering_service(peering_service_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPeeringServiceResult
def get_peering_service_output(peering_service_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPeeringServiceResult]
    func LookupPeeringService(ctx *Context, args *LookupPeeringServiceArgs, opts ...InvokeOption) (*LookupPeeringServiceResult, error)
func LookupPeeringServiceOutput(ctx *Context, args *LookupPeeringServiceOutputArgs, opts ...InvokeOption) LookupPeeringServiceResultOutput

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

    public static class GetPeeringService 
{
    public static Task<GetPeeringServiceResult> InvokeAsync(GetPeeringServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetPeeringServiceResult> Invoke(GetPeeringServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPeeringServiceResult> getPeeringService(GetPeeringServiceArgs args, InvokeOptions options)
public static Output<GetPeeringServiceResult> getPeeringService(GetPeeringServiceArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PeeringServiceName string
    The name of the peering.
    ResourceGroupName string
    The name of the resource group.
    PeeringServiceName string
    The name of the peering.
    ResourceGroupName string
    The name of the resource group.
    peeringServiceName String
    The name of the peering.
    resourceGroupName String
    The name of the resource group.
    peeringServiceName string
    The name of the peering.
    resourceGroupName string
    The name of the resource group.
    peering_service_name str
    The name of the peering.
    resource_group_name str
    The name of the resource group.
    peeringServiceName String
    The name of the peering.
    resourceGroupName String
    The name of the resource group.

    getPeeringService Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The ID of the resource.
    Location string
    The location of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    LogAnalyticsWorkspaceProperties Pulumi.AzureNative.Peering.Outputs.LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    PeeringServiceLocation string
    The location (state/province) of the customer.
    PeeringServiceProvider string
    The name of the service provider.
    ProviderBackupPeeringLocation string
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    ProviderPrimaryPeeringLocation string
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    Sku Pulumi.AzureNative.Peering.Outputs.PeeringServiceSkuResponse
    The SKU that defines the type of the peering service.
    Tags Dictionary<string, string>
    The resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The ID of the resource.
    Location string
    The location of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    LogAnalyticsWorkspaceProperties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    PeeringServiceLocation string
    The location (state/province) of the customer.
    PeeringServiceProvider string
    The name of the service provider.
    ProviderBackupPeeringLocation string
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    ProviderPrimaryPeeringLocation string
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    Sku PeeringServiceSkuResponse
    The SKU that defines the type of the peering service.
    Tags map[string]string
    The resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The ID of the resource.
    location String
    The location of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    logAnalyticsWorkspaceProperties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    peeringServiceLocation String
    The location (state/province) of the customer.
    peeringServiceProvider String
    The name of the service provider.
    providerBackupPeeringLocation String
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    providerPrimaryPeeringLocation String
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku PeeringServiceSkuResponse
    The SKU that defines the type of the peering service.
    tags Map<String,String>
    The resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The ID of the resource.
    location string
    The location of the resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning state of the resource.
    type string
    The type of the resource.
    logAnalyticsWorkspaceProperties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    peeringServiceLocation string
    The location (state/province) of the customer.
    peeringServiceProvider string
    The name of the service provider.
    providerBackupPeeringLocation string
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    providerPrimaryPeeringLocation string
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku PeeringServiceSkuResponse
    The SKU that defines the type of the peering service.
    tags {[key: string]: string}
    The resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The ID of the resource.
    location str
    The location of the resource.
    name str
    The name of the resource.
    provisioning_state str
    The provisioning state of the resource.
    type str
    The type of the resource.
    log_analytics_workspace_properties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    peering_service_location str
    The location (state/province) of the customer.
    peering_service_provider str
    The name of the service provider.
    provider_backup_peering_location str
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    provider_primary_peering_location str
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku PeeringServiceSkuResponse
    The SKU that defines the type of the peering service.
    tags Mapping[str, str]
    The resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The ID of the resource.
    location String
    The location of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    logAnalyticsWorkspaceProperties Property Map
    The Log Analytics Workspace Properties
    peeringServiceLocation String
    The location (state/province) of the customer.
    peeringServiceProvider String
    The name of the service provider.
    providerBackupPeeringLocation String
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    providerPrimaryPeeringLocation String
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku Property Map
    The SKU that defines the type of the peering service.
    tags Map<String>
    The resource tags.

    Supporting Types

    LogAnalyticsWorkspacePropertiesResponse

    ConnectedAgents List<string>
    The list of connected agents.
    Key string
    The Workspace Key.
    WorkspaceID string
    The Workspace ID.
    ConnectedAgents []string
    The list of connected agents.
    Key string
    The Workspace Key.
    WorkspaceID string
    The Workspace ID.
    connectedAgents List<String>
    The list of connected agents.
    key String
    The Workspace Key.
    workspaceID String
    The Workspace ID.
    connectedAgents string[]
    The list of connected agents.
    key string
    The Workspace Key.
    workspaceID string
    The Workspace ID.
    connected_agents Sequence[str]
    The list of connected agents.
    key str
    The Workspace Key.
    workspace_id str
    The Workspace ID.
    connectedAgents List<String>
    The list of connected agents.
    key String
    The Workspace Key.
    workspaceID String
    The Workspace ID.

    PeeringServiceSkuResponse

    Name string
    The name of the peering service SKU.
    Name string
    The name of the peering service SKU.
    name String
    The name of the peering service SKU.
    name string
    The name of the peering service SKU.
    name str
    The name of the peering service SKU.
    name String
    The name of the peering service SKU.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.7.0 published on Wednesday, Aug 13, 2025 by Pulumi
    pulumi/pulumi-azure-native