1. Packages
  2. Azure Native
  3. API Docs
  4. machinelearningservices
  5. getBatchEndpoint
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.machinelearningservices.getBatchEndpoint

Explore with Pulumi AI

azure-native logo
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Azure REST API version: 2023-04-01.

    Other available API versions: 2021-03-01-preview, 2022-02-01-preview, 2023-04-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2023-10-01, 2024-01-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:

    BatchEndpointProperties Pulumi.AzureNative.MachineLearningServices.Outputs.BatchEndpointResponse
    [Required] Additional attributes of the entity.
    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
    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.
    BatchEndpointProperties BatchEndpointResponse
    [Required] Additional attributes of the entity.
    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
    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.
    batchEndpointProperties BatchEndpointResponse
    [Required] Additional attributes of the entity.
    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
    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.
    batchEndpointProperties BatchEndpointResponse
    [Required] Additional attributes of the entity.
    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
    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.
    batch_endpoint_properties BatchEndpointResponse
    [Required] Additional attributes of the entity.
    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
    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.
    batchEndpointProperties Property Map
    [Required] Additional attributes of the entity.
    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
    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

    BatchEndpointDefaultsResponse

    DeploymentName string
    Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.
    DeploymentName string
    Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.
    deploymentName String
    Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.
    deploymentName string
    Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.
    deployment_name str
    Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.
    deploymentName String
    Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.

    BatchEndpointResponse

    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.
    Defaults Pulumi.AzureNative.MachineLearningServices.Inputs.BatchEndpointDefaultsResponse
    Default values for Batch Endpoint
    Description string
    Description of the inference endpoint.
    Properties Dictionary<string, string>
    Property dictionary. Properties can be added, but not removed or altered.
    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.
    Defaults BatchEndpointDefaultsResponse
    Default values for Batch Endpoint
    Description string
    Description of the inference endpoint.
    Properties map[string]string
    Property dictionary. Properties can be added, but not removed or altered.
    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.
    defaults BatchEndpointDefaultsResponse
    Default values for Batch Endpoint
    description String
    Description of the inference endpoint.
    properties Map<String,String>
    Property dictionary. Properties can be added, but not removed or altered.
    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.
    defaults BatchEndpointDefaultsResponse
    Default values for Batch Endpoint
    description string
    Description of the inference endpoint.
    properties {[key: string]: string}
    Property dictionary. Properties can be added, but not removed or altered.
    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.
    defaults BatchEndpointDefaultsResponse
    Default values for Batch Endpoint
    description str
    Description of the inference endpoint.
    properties Mapping[str, str]
    Property dictionary. Properties can be added, but not removed or altered.
    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.
    defaults Property Map
    Default values for Batch Endpoint
    description String
    Description of the inference endpoint.
    properties Map<String>
    Property dictionary. Properties can be added, but not removed or altered.

    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.

    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
    azure-native logo
    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.37.0 published on Monday, Apr 15, 2024 by Pulumi