https://github.com/Azure/azure-sdk-for-java: This package contains Microsoft BatchAI Management SDK. A new set of management libraries are now Generally Available. For documentation on how to use the new libraries, please see https://aka.ms/azsdk/java/mgmt
  • Microsoft 
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
package com.microsoft.azure.management.batchai;


import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Indexable;


Specifies settings for container image.

/**
 * Specifies settings for container image.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_8_0)
public interface ContainerImageSettings extends Indexable,
        HasParent<BatchAIJob>,
        HasInner<OutputDirectory> {

    
Definition of ContainerImage settings.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
     * Definition of ContainerImage settings.
     *
     * @param <ParentT> the stage of the parent definition to return to after attaching this definition
     */
    interface Definition<ParentT> extends
            DefinitionStages.Blank<ParentT>,
            DefinitionStages.WithRegistryCredentials<ParentT>,
            DefinitionStages.WithAttach<ParentT> {
    }

    
Definition stages for container image settings.

/**
     * Definition stages for container image settings.
     */
    interface DefinitionStages {

        
The final stage of the output directory settings definition.
At this stage, any remaining optional settings can be specified, or the output directory settings definition
can be attached to the parent Batch AI job definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The final stage of the output directory settings definition.
         * At this stage, any remaining optional settings can be specified, or the output directory settings definition
         * can be attached to the parent Batch AI job definition.
         *
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
                Attachable.InDefinition<ParentT>,
                WithShmSize<ParentT> {
            
Specifies url for container registry.

Params:
  • serverUrl – URL for image repository
Returns:the next stage of the definition
/**
             * Specifies url for container registry.
             * @param serverUrl URL for image repository
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withRegistryUrl(String serverUrl);

            
Specifies username to login to container registry.

Params:
  • username – user name to login
Returns:the next stage of the definition
/**
             * Specifies username to login to container registry.
             * @param username user name to login
             * @return the next stage of the definition
             */
            WithRegistryCredentials<ParentT> withRegistryUsername(String username);
        }

        
The first stage of the output directory settings definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The first stage of the output directory settings definition.
         *
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithAttach<ParentT> {
        }

        
Specifies container registry credentials.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * Specifies container registry credentials.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithRegistryCredentials<ParentT> {
            
Specifies password for container registry.

Params:
  • password – password to login
Returns:the next stage of the definition
/**
             * Specifies password for container registry.
             * @param password password to login
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withRegistryPassword(String password);

            
Specifies the location of the password, which is a Key Vault Secret.
Users can store their secrets in Azure KeyVault and pass it to the Batch
AI Service to integrate with KeyVault.

Params:
  • keyVaultId – the key vault id
  • secretUrl – the secret ulr
Returns:the next stage of the definition
/**
             * Specifies the location of the password, which is a Key Vault Secret.
             * Users can store their secrets in Azure KeyVault and pass it to the Batch
             * AI Service to integrate with KeyVault.
             *
             * @param keyVaultId the key vault id
             * @param secretUrl the secret ulr
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withRegistrySecretReference(String keyVaultId, String secretUrl);
        }

        
Specifies size of /dev/shm. Please refer to docker documentation for supported argument formats.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * Specifies size of /dev/shm. Please refer to docker documentation for supported argument formats.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        @Beta(Beta.SinceVersion.V1_12_0)
        interface WithShmSize<ParentT> {
            
Specifies size of /dev/shm.

Params:
  • shmSize – size of /dev/shm
Returns:the next stage of the definition
/**
             * Specifies size of /dev/shm.
             * @param shmSize size of /dev/shm
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withShmSize(String shmSize);
        }
    }

}