swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Supportedimages API schemes: - https tags: - name: Supportedimages paths: /supportedimages: get: operationId: microsoftAzureBatchListsupportedimages summary: Microsoft Azure Lists All Virtual Machine Images Supported By The Azure Batch Service description: Lists all Virtual Machine Images supported by the Azure Batch service. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.' required: false type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchAccountListSupportedImagesResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Account list node agent skus: $ref: ./examples/AccountListSupportedImages.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Supportedimages definitions: ImageInfo: type: object description: 'A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.' properties: nodeAgentSKUId: type: string description: The ID of the Compute Node agent SKU which the Image supports. x-ms-client-name: nodeAgentSkuId imageReference: $ref: '#/definitions/ImageReference' description: The reference to the Azure Virtual Machine's Marketplace Image. osType: $ref: '#/definitions/OSType' description: The type of operating system (e.g. Windows or Linux) of the Image. capabilities: type: array description: The capabilities or features which the Image supports. Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service. items: type: string batchSupportEndOfLife: type: string format: date-time description: The time when the Azure Batch service will stop accepting create Pool requests for the Image. verificationType: $ref: '#/definitions/ImageVerificationType' description: Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU. required: - nodeAgentSKUId - imageReference - osType - verificationType OSType: type: string description: OSType enums enum: - linux - windows x-ms-enum: name: OSType modelAsString: true values: - name: Linux value: linux description: The Linux operating system. - name: Windows value: windows description: The Windows operating system. BatchError: type: object description: An error response received from the Azure Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/BatchErrorMessage' description: A message describing the error, intended to be suitable for display in a user interface. values: type: array description: A collection of key-value pairs containing additional details about the error. items: $ref: '#/definitions/BatchErrorDetail' x-ms-identifiers: [] required: - code BatchAccountListSupportedImagesResult: type: object description: The result of listing the supported Virtual Machine Images. properties: value: type: array description: The list of supported Virtual Machine Images. items: $ref: '#/definitions/ImageInfo' x-ms-identifiers: [] odata.nextLink: type: string description: The URL to get the next set of results. ImageReference: type: object description: 'A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the '' List Supported Images '' operation.' properties: publisher: type: string description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. offer: type: string description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. sku: type: string description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. version: type: string description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. virtualMachineImageId: type: string description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. exactVersion: type: string description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. readOnly: true BatchErrorMessage: type: object description: An error message received in an Azure Batch error response. properties: lang: type: string description: The language code of the error message. value: type: string description: The text of the message. BatchErrorDetail: type: object description: An item of additional information included in an Azure Batch error response. properties: key: type: string description: An identifier specifying the meaning of the Value property. value: type: string description: The additional information included with the error response. ImageVerificationType: type: string description: ImageVerificationType enums enum: - verified - unverified x-ms-enum: name: ImageVerificationType modelAsString: true values: - name: Verified value: verified description: The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all Batch features have been confirmed to work as expected. - name: Unverified value: unverified description: The associated Compute Node agent SKU should have binary compatibility with the Image, but specific functionality has not been verified. parameters: Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'