ListManagementImageOperations Class

ListManagementImageOperations operations.

Inheritance

builtins.object

ListManagementImageOperations

Constructor

ListManagementImageOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Methods

add_image	Add an image to the list with list Id equal to list Id passed.
add_image_file_input	Add an image to the list with list Id equal to list Id passed.
add_image_url_input	Add an image to the list with list Id equal to list Id passed.
delete_all_images	Deletes all images from the list with list Id equal to list Id passed.
delete_image	Deletes an image from the list with list Id and image Id passed.
get_all_image_ids	Gets all image Ids from the list with list Id equal to list Id passed.

add_image

Add an image to the list with list Id equal to list Id passed.

add_image(list_id, tag=None, label=None, custom_headers=None, raw=False, **operation_config)

Parameters

list_id

str

Required

List Id of the image list.

tag

int

default value: None

Tag for the image.

label

str

default value: None

The image label.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Image or ClientRawResponse if raw=true

Return type

Image,

ClientRawResponse

Exceptions

APIErrorException

add_image_file_input

Add an image to the list with list Id equal to list Id passed.

add_image_file_input(list_id, image_stream, tag=None, label=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

list_id

str

Required

List Id of the image list.

image_stream

<xref:Generator>

Required

The image file.

tag

int

default value: None

Tag for the image.

label

str

default value: None

The image label.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

callback

<xref:Callable>[<xref:Bytes>, <xref:response=None>]

default value: None

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

operation_config

Required

Operation configuration overrides.

Returns

Image or ClientRawResponse if raw=true

Return type

Image,

ClientRawResponse

Exceptions

APIErrorException

add_image_url_input

Add an image to the list with list Id equal to list Id passed.

add_image_url_input(list_id, content_type, tag=None, label=None, data_representation='URL', value=None, custom_headers=None, raw=False, **operation_config)

Parameters

list_id

str

Required

List Id of the image list.

content_type

str

Required

The content type.

tag

int

default value: None

Tag for the image.

label

str

default value: None

The image label.

data_representation

str

default value: URL

value

str

default value: None

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Image or ClientRawResponse if raw=true

Return type

Image,

ClientRawResponse

Exceptions

APIErrorException

delete_all_images

Deletes all images from the list with list Id equal to list Id passed.

delete_all_images(list_id, custom_headers=None, raw=False, **operation_config)

Parameters

list_id

str

Required

List Id of the image list.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str,

ClientRawResponse

Exceptions

APIErrorException

delete_image

Deletes an image from the list with list Id and image Id passed.

delete_image(list_id, image_id, custom_headers=None, raw=False, **operation_config)

Parameters

list_id

str

Required

List Id of the image list.

image_id

str

Required

Id of the image.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str,

ClientRawResponse

Exceptions

APIErrorException

get_all_image_ids

Gets all image Ids from the list with list Id equal to list Id passed.

get_all_image_ids(list_id, custom_headers=None, raw=False, **operation_config)

Parameters

list_id

str

Required

List Id of the image list.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

ImageIds or ClientRawResponse if raw=true

Return type

ImageIds,

ClientRawResponse

Exceptions

APIErrorException

Attributes

models

models = <module 'azure.cognitiveservices.vision.contentmoderator.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\cognitiveservices\\vision\\contentmoderator\\models\\__init__.py'>