Azure Native v1.102.0, May 2 23

azure-native.machinelearningservices.getBatchEndpoint

Explore with Pulumi AI

API Version: 2021-03-01-preview.

Using getBatchEndpoint

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 getBatchEndpoint(args: GetBatchEndpointArgs, opts?: InvokeOptions): Promise<GetBatchEndpointResult>
function getBatchEndpointOutput(args: GetBatchEndpointOutputArgs, opts?: InvokeOptions): Output<GetBatchEndpointResult>

def get_batch_endpoint(endpoint_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       workspace_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetBatchEndpointResult
def get_batch_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[GetBatchEndpointResult]

func LookupBatchEndpoint(ctx *Context, args *LookupBatchEndpointArgs, opts ...InvokeOption) (*LookupBatchEndpointResult, error)
func LookupBatchEndpointOutput(ctx *Context, args *LookupBatchEndpointOutputArgs, opts ...InvokeOption) LookupBatchEndpointResultOutput

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

public static class GetBatchEndpoint 
{
    public static Task<GetBatchEndpointResult> InvokeAsync(GetBatchEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetBatchEndpointResult> Invoke(GetBatchEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBatchEndpointResult> getBatchEndpoint(GetBatchEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

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

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

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

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

endpoint_name str: Name for the Batch Endpoint.
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: Name for the Batch Endpoint.
resourceGroupName String: The name of the resource group. The name is case insensitive.
workspaceName String: Name of Azure Machine Learning workspace.

getBatchEndpoint 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
Properties Pulumi.AzureNative.MachineLearningServices.Outputs.BatchEndpointResponse: [Required] Additional attributes of the entity.
SystemData Pulumi.AzureNative.MachineLearningServices.Outputs.SystemDataResponse: System data associated with resource provider
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity Pulumi.AzureNative.MachineLearningServices.Outputs.ResourceIdentityResponse: Service identity associated with a resource.
Kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
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
Properties BatchEndpointResponse: [Required] Additional attributes of the entity.
SystemData SystemDataResponse: System data associated with resource provider
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity ResourceIdentityResponse: Service identity associated with a resource.
Kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
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
properties BatchEndpointResponse: [Required] Additional attributes of the entity.
systemData SystemDataResponse: System data associated with resource provider
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ResourceIdentityResponse: Service identity associated with a resource.
kind String: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
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
properties BatchEndpointResponse: [Required] Additional attributes of the entity.
systemData SystemDataResponse: System data associated with resource provider
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ResourceIdentityResponse: Service identity associated with a resource.
kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
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
properties BatchEndpointResponse: [Required] Additional attributes of the entity.
system_data SystemDataResponse: System data associated with resource provider
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ResourceIdentityResponse: Service identity associated with a resource.
kind str: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
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
properties Property Map: [Required] Additional attributes of the entity.
systemData Property Map: System data associated with resource provider
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity Property Map: Service identity associated with a resource.
kind String: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
tags Map<String>: Resource tags.

Supporting Types

BatchEndpointResponse

ScoringUri string: Endpoint URI.
SwaggerUri string: Endpoint Swagger URI.
AuthMode string: [Required] Inference endpoint authentication mode type
Description string: Description of the inference endpoint.
Properties Dictionary<string, string>: Property dictionary. Properties can be added, but not removed or altered.
Traffic Dictionary<string, int>: Traffic rules on how the traffic will be routed across deployments.

ScoringUri string: Endpoint URI.
SwaggerUri string: Endpoint Swagger URI.
AuthMode string: [Required] Inference endpoint authentication mode type
Description string: Description of the inference endpoint.
Properties map[string]string: Property dictionary. Properties can be added, but not removed or altered.
Traffic map[string]int: Traffic rules on how the traffic will be routed across deployments.

scoringUri String: Endpoint URI.
swaggerUri String: Endpoint Swagger URI.
authMode String: [Required] Inference endpoint authentication mode type
description String: Description of the inference endpoint.
properties Map<String,String>: Property dictionary. Properties can be added, but not removed or altered.
traffic Map<String,Integer>: Traffic rules on how the traffic will be routed across deployments.

scoringUri string: Endpoint URI.
swaggerUri string: Endpoint Swagger URI.
authMode string: [Required] Inference endpoint authentication mode type
description string: Description of the inference endpoint.
properties {[key: string]: string}: Property dictionary. Properties can be added, but not removed or altered.
traffic {[key: string]: number}: Traffic rules on how the traffic will be routed across deployments.

scoring_uri str: Endpoint URI.
swagger_uri str: Endpoint Swagger URI.
auth_mode str: [Required] Inference endpoint authentication mode type
description str: Description of the inference endpoint.
properties Mapping[str, str]: Property dictionary. Properties can be added, but not removed or altered.
traffic Mapping[str, int]: Traffic rules on how the traffic will be routed across deployments.

scoringUri String: Endpoint URI.
swaggerUri String: Endpoint Swagger URI.
authMode String: [Required] Inference endpoint authentication mode type
description String: Description of the inference endpoint.
properties Map<String>: Property dictionary. Properties can be added, but not removed or altered.
traffic Map<Number>: Traffic rules on how the traffic will be routed across deployments.

ResourceIdentityResponse

PrincipalId string: Client ID that is used when authenticating.
TenantId string: AAD Tenant where this identity lives.
Type string: Defines values for a ResourceIdentity's type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityMetaResponse>: Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

PrincipalId string: Client ID that is used when authenticating.
TenantId string: AAD Tenant where this identity lives.
Type string: Defines values for a ResourceIdentity's type.
UserAssignedIdentities map[string]UserAssignedIdentityMetaResponse: Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

principalId String: Client ID that is used when authenticating.
tenantId String: AAD Tenant where this identity lives.
type String: Defines values for a ResourceIdentity's type.
userAssignedIdentities Map<String,UserAssignedIdentityMetaResponse>: Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

principalId string: Client ID that is used when authenticating.
tenantId string: AAD Tenant where this identity lives.
type string: Defines values for a ResourceIdentity's type.
userAssignedIdentities {[key: string]: UserAssignedIdentityMetaResponse}: Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

principal_id str: Client ID that is used when authenticating.
tenant_id str: AAD Tenant where this identity lives.
type str: Defines values for a ResourceIdentity's type.
user_assigned_identities Mapping[str, UserAssignedIdentityMetaResponse]: Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

principalId String: Client ID that is used when authenticating.
tenantId String: AAD Tenant where this identity lives.
type String: Defines values for a ResourceIdentity's type.
userAssignedIdentities Map<Property Map>: Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC)
CreatedBy string: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for the identity that last modified the resource
lastModifiedByType String: The type of identity that last modified the resource

UserAssignedIdentityMetaResponse

ClientId string: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
PrincipalId string: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

ClientId string: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
PrincipalId string: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

clientId String: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId String: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

clientId string: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId string: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

client_id str: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principal_id str: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

clientId String: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId String: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0