IBatchDeployment Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.BatchDeploymentTypeConverter))]
public interface IBatchDeployment : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api30.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.BatchDeploymentTypeConverter))>]
type IBatchDeployment = interface
interface IJsonSerializable
interface ITrackedResource
interface IResource
Public Interface IBatchDeployment
Implements ITrackedResource
- Derived
- Attributes
- Implements
Properties
CodeConfigurationCodeId |
ARM resource ID of the code asset. |
CodeConfigurationScoringScript |
[Required] The script to execute on startup. eg. "score.py" |
Compute |
Compute target for batch inference operation. |
DeploymentConfigurationType |
[Required] The type of the deployment |
Description |
Description of the endpoint deployment. |
EndpointDeploymentPropertiesBaseProperty |
Property dictionary. Properties can be added, but not removed or altered. |
EnvironmentId |
ARM resource ID or AssetId of the environment specification for the endpoint deployment. |
EnvironmentVariable |
Environment variables configuration for the deployment. |
ErrorThreshold |
Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} (Inherited from IResource) |
IdentityPrincipalId |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
IdentityTenantId |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
IdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
IdentityUserAssignedIdentity |
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. |
Kind |
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. |
Location |
The geo-location where the resource lives (Inherited from ITrackedResource) |
LoggingLevel |
Logging level for batch inference operation. |
MaxConcurrencyPerInstance |
Indicates maximum number of parallelism per instance. |
MiniBatchSize |
Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. |
Model |
Reference to the model asset for the endpoint deployment. |
Name |
The name of the resource (Inherited from IResource) |
OutputAction |
Indicates how the output will be organized. |
OutputFileName |
Customized output file name for append_row output action. |
ProvisioningState |
Provisioning state for the endpoint deployment. |
ResourceInstanceCount |
Optional number of instances or nodes used by the compute target. |
ResourceInstanceType |
Optional type of VM used as supported by the compute target. |
ResourceProperty |
Additional properties bag. |
RetrySettingMaxRetry |
Maximum retry count for a mini-batch |
RetrySettingTimeout |
Invocation timeout for a mini-batch, in ISO 8601 format. |
SkuCapacity |
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. |
SkuFamily |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
SkuName |
The name of the SKU. Ex - P3. It is typically a letter+number code |
SkuSize |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
SkuTier |
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. |
SystemDataCreatedAt |
The timestamp of resource creation (UTC). (Inherited from IResource) |
SystemDataCreatedBy |
The identity that created the resource. (Inherited from IResource) |
SystemDataCreatedByType |
The type of identity that created the resource. (Inherited from IResource) |
SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) (Inherited from IResource) |
SystemDataLastModifiedBy |
The identity that last modified the resource. (Inherited from IResource) |
SystemDataLastModifiedByType |
The type of identity that last modified the resource. (Inherited from IResource) |
Tag |
Resource tags. (Inherited from ITrackedResource) |
Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
XmsAsyncOperationTimeout |
Methods
ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |