Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. recommendationsservice
  5. getServiceEndpoint
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.recommendationsservice.getServiceEndpoint

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

Returns ServiceEndpoint resources for a given name.

Uses Azure REST API version 2022-03-01-preview.

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

Using getServiceEndpoint

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 getServiceEndpoint(args: GetServiceEndpointArgs, opts?: InvokeOptions): Promise<GetServiceEndpointResult>
function getServiceEndpointOutput(args: GetServiceEndpointOutputArgs, opts?: InvokeOptions): Output<GetServiceEndpointResult>
Copy
def get_service_endpoint(account_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         service_endpoint_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetServiceEndpointResult
def get_service_endpoint_output(account_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         service_endpoint_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetServiceEndpointResult]
Copy
func LookupServiceEndpoint(ctx *Context, args *LookupServiceEndpointArgs, opts ...InvokeOption) (*LookupServiceEndpointResult, error)
func LookupServiceEndpointOutput(ctx *Context, args *LookupServiceEndpointOutputArgs, opts ...InvokeOption) LookupServiceEndpointResultOutput
Copy

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

public static class GetServiceEndpoint 
{
    public static Task<GetServiceEndpointResult> InvokeAsync(GetServiceEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceEndpointResult> Invoke(GetServiceEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceEndpointResult> getServiceEndpoint(GetServiceEndpointArgs args, InvokeOptions options)
public static Output<GetServiceEndpointResult> getServiceEndpoint(GetServiceEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:recommendationsservice:getServiceEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RecommendationsService Account resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ServiceEndpoint resource.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RecommendationsService Account resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ServiceEndpoint resource.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RecommendationsService Account resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ServiceEndpoint resource.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RecommendationsService Account resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ServiceEndpoint resource.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the RecommendationsService Account resource.
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_endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ServiceEndpoint resource.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RecommendationsService Account resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ServiceEndpoint resource.

getServiceEndpoint 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}
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.RecommendationsService.Outputs.ServiceEndpointResourceResponseProperties
ServiceEndpoint resource properties.
SystemData Pulumi.AzureNative.RecommendationsService.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
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}
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties ServiceEndpointResourceResponseProperties
ServiceEndpoint resource properties.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
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}
location String
The geo-location where the resource lives
name String
The name of the resource
properties ServiceEndpointResourceResponseProperties
ServiceEndpoint resource properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
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}
location string
The geo-location where the resource lives
name string
The name of the resource
properties ServiceEndpointResourceResponseProperties
ServiceEndpoint resource properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
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}
location str
The geo-location where the resource lives
name str
The name of the resource
properties ServiceEndpointResourceResponseProperties
ServiceEndpoint resource properties.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
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}
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
ServiceEndpoint resource properties.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

ServiceEndpointResourceResponseProperties

PairedLocation This property is required. string
The paired location that will be used by this ServiceEndpoint.
ProvisioningState This property is required. string
The resource provisioning state.
Url This property is required. string
The URL where the ServiceEndpoint API is accessible at.
PreAllocatedCapacity int
ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity.
PairedLocation This property is required. string
The paired location that will be used by this ServiceEndpoint.
ProvisioningState This property is required. string
The resource provisioning state.
Url This property is required. string
The URL where the ServiceEndpoint API is accessible at.
PreAllocatedCapacity int
ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity.
pairedLocation This property is required. String
The paired location that will be used by this ServiceEndpoint.
provisioningState This property is required. String
The resource provisioning state.
url This property is required. String
The URL where the ServiceEndpoint API is accessible at.
preAllocatedCapacity Integer
ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity.
pairedLocation This property is required. string
The paired location that will be used by this ServiceEndpoint.
provisioningState This property is required. string
The resource provisioning state.
url This property is required. string
The URL where the ServiceEndpoint API is accessible at.
preAllocatedCapacity number
ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity.
paired_location This property is required. str
The paired location that will be used by this ServiceEndpoint.
provisioning_state This property is required. str
The resource provisioning state.
url This property is required. str
The URL where the ServiceEndpoint API is accessible at.
pre_allocated_capacity int
ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity.
pairedLocation This property is required. String
The paired location that will be used by this ServiceEndpoint.
provisioningState This property is required. String
The resource provisioning state.
url This property is required. String
The URL where the ServiceEndpoint API is accessible at.
preAllocatedCapacity Number
ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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