Azure Native v2.73.0, Nov 20 24

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.machinelearningservices.getOnlineEndpoint

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getOnlineEndpoint

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 getOnlineEndpoint(args: GetOnlineEndpointArgs, opts?: InvokeOptions): Promise<GetOnlineEndpointResult>
function getOnlineEndpointOutput(args: GetOnlineEndpointOutputArgs, opts?: InvokeOptions): Output<GetOnlineEndpointResult>

def get_online_endpoint(endpoint_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        workspace_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetOnlineEndpointResult
def get_online_endpoint_output(endpoint_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        workspace_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetOnlineEndpointResult]

func LookupOnlineEndpoint(ctx *Context, args *LookupOnlineEndpointArgs, opts ...InvokeOption) (*LookupOnlineEndpointResult, error)
func LookupOnlineEndpointOutput(ctx *Context, args *LookupOnlineEndpointOutputArgs, opts ...InvokeOption) LookupOnlineEndpointResultOutput

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

public static class GetOnlineEndpoint 
{
    public static Task<GetOnlineEndpointResult> InvokeAsync(GetOnlineEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetOnlineEndpointResult> Invoke(GetOnlineEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOnlineEndpointResult> getOnlineEndpoint(GetOnlineEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:machinelearningservices:getOnlineEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointName string: Online Endpoint name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
WorkspaceName string: Name of Azure Machine Learning workspace.

EndpointName string: Online Endpoint name.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
WorkspaceName string: Name of Azure Machine Learning workspace.

endpointName String: Online Endpoint name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: Name of Azure Machine Learning workspace.

endpointName string: Online Endpoint name.
resourceGroupName string: The name of the resource group. The name is case insensitive.
workspaceName string: Name of Azure Machine Learning workspace.

endpoint_name str: Online Endpoint name.
resource_group_name str: The name of the resource group. The name is case insensitive.
workspace_name str: Name of Azure Machine Learning workspace.

endpointName String: Online Endpoint name.
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: Name of Azure Machine Learning workspace.

getOnlineEndpoint 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}
Location string: The geo-location where the resource lives
Name string: The name of the resource
OnlineEndpointProperties Pulumi.AzureNative.MachineLearningServices.Outputs.OnlineEndpointResponse: [Required] Additional attributes of the entity.
SystemData Pulumi.AzureNative.MachineLearningServices.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity Pulumi.AzureNative.MachineLearningServices.Outputs.ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
Kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
Sku Pulumi.AzureNative.MachineLearningServices.Outputs.SkuResponse: Sku details required for ARM contract for Autoscaling.
Tags Dictionary<string, string>: Resource tags.

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
OnlineEndpointProperties OnlineEndpointResponse: [Required] Additional attributes of the entity.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
Kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
Sku SkuResponse: Sku details required for ARM contract for Autoscaling.
Tags map[string]string: Resource tags.

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
onlineEndpointProperties OnlineEndpointResponse: [Required] Additional attributes of the entity.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
kind String: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
sku SkuResponse: Sku details required for ARM contract for Autoscaling.
tags Map<String,String>: Resource tags.

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
onlineEndpointProperties OnlineEndpointResponse: [Required] Additional attributes of the entity.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
sku SkuResponse: Sku details required for ARM contract for Autoscaling.
tags {[key: string]: string}: Resource tags.

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
online_endpoint_properties OnlineEndpointResponse: [Required] Additional attributes of the entity.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
kind str: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
sku SkuResponse: Sku details required for ARM contract for Autoscaling.
tags Mapping[str, str]: Resource tags.

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
onlineEndpointProperties Property Map: [Required] Additional attributes of the entity.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity Property Map: Managed service identity (system assigned and/or user assigned identities)
kind String: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
sku Property Map: Sku details required for ARM contract for Autoscaling.
tags Map<String>: Resource tags.

Supporting Types

ManagedServiceIdentityResponse

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principal_id str: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id str: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type str: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

OnlineEndpointResponse

AuthMode string: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
ProvisioningState string: Provisioning state for the endpoint.
ScoringUri string: Endpoint URI.
SwaggerUri string: Endpoint Swagger URI.
Compute string: ARM resource ID of the compute if it exists. optional
Description string: Description of the inference endpoint.
MirrorTraffic Dictionary<string, int>: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
Properties Dictionary<string, string>: Property dictionary. Properties can be added, but not removed or altered.
PublicNetworkAccess string: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
Traffic Dictionary<string, int>: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

AuthMode string: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
ProvisioningState string: Provisioning state for the endpoint.
ScoringUri string: Endpoint URI.
SwaggerUri string: Endpoint Swagger URI.
Compute string: ARM resource ID of the compute if it exists. optional
Description string: Description of the inference endpoint.
MirrorTraffic map[string]int: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
Properties map[string]string: Property dictionary. Properties can be added, but not removed or altered.
PublicNetworkAccess string: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
Traffic map[string]int: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

authMode String: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
provisioningState String: Provisioning state for the endpoint.
scoringUri String: Endpoint URI.
swaggerUri String: Endpoint Swagger URI.
compute String: ARM resource ID of the compute if it exists. optional
description String: Description of the inference endpoint.
mirrorTraffic Map<String,Integer>: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
properties Map<String,String>: Property dictionary. Properties can be added, but not removed or altered.
publicNetworkAccess String: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
traffic Map<String,Integer>: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

authMode string: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
provisioningState string: Provisioning state for the endpoint.
scoringUri string: Endpoint URI.
swaggerUri string: Endpoint Swagger URI.
compute string: ARM resource ID of the compute if it exists. optional
description string: Description of the inference endpoint.
mirrorTraffic {[key: string]: number}: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
properties {[key: string]: string}: Property dictionary. Properties can be added, but not removed or altered.
publicNetworkAccess string: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
traffic {[key: string]: number}: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

auth_mode str: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
provisioning_state str: Provisioning state for the endpoint.
scoring_uri str: Endpoint URI.
swagger_uri str: Endpoint Swagger URI.
compute str: ARM resource ID of the compute if it exists. optional
description str: Description of the inference endpoint.
mirror_traffic Mapping[str, int]: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
properties Mapping[str, str]: Property dictionary. Properties can be added, but not removed or altered.
public_network_access str: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
traffic Mapping[str, int]: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

authMode String: [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
provisioningState String: Provisioning state for the endpoint.
scoringUri String: Endpoint URI.
swaggerUri String: Endpoint Swagger URI.
compute String: ARM resource ID of the compute if it exists. optional
description String: Description of the inference endpoint.
mirrorTraffic Map<Number>: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
properties Map<String>: Property dictionary. Properties can be added, but not removed or altered.
publicNetworkAccess String: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
traffic Map<Number>: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

SkuResponse

Name string: The name of the SKU. Ex - P3. It is typically a letter+number code
Capacity int: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name string: The name of the SKU. Ex - P3. It is typically a letter+number code
Capacity int: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
Family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name String: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity Integer: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family String: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name string: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity number: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name str: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity int: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family str: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier str: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name String: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity Number: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family String: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

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.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.
TenantId string: The tenant ID of the user assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.
TenantId string: The tenant ID of the user assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.
tenantId String: The tenant ID of the user assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.
tenantId string: The tenant ID of the user assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.
tenant_id str: The tenant ID of the user assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.
tenantId String: The tenant ID of the user assigned identity.

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.machinelearningservices.getOnlineEndpoint

On this page

On this page

Using getOnlineEndpoint

getOnlineEndpoint Result

Supporting Types

ManagedServiceIdentityResponse

OnlineEndpointResponse

SkuResponse

SystemDataResponse

UserAssignedIdentityResponse

Package Details

On this page

On this page