Share via

ListManagementImageOperations Class

  • Reference

ListManagementImageOperations operations.

Inheritance
builtins.object
ListManagementImageOperations

Constructor

ListManagementImageOperations(client, config, serializer, deserializer)

Parameters

Name Description
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

Name Description
list_id
Required
str

List Id of the image list.
tag
Required
int

Tag for the image.

Default value: None
label
Required
str

The image label.

Default value: None
custom_headers
Required
dict

headers that will be added to the request

Default value: None
raw
Required
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
Image,
<xref:msrest.pipeline.ClientRawResponse>

Image or ClientRawResponse if raw=true

Exceptions

Type Description
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

Name Description
list_id
Required
str

List Id of the image list.
image_stream
Required
Generator

The image file.
tag
Required
int

Tag for the image.

Default value: None
label
Required
str

The image label.

Default value: None
custom_headers
Required
dict

headers that will be added to the request

Default value: None
raw
Required
bool

returns the direct response alongside the deserialized response

Default value: False
callback
Required
Callable[<xref:Bytes>, <xref:response=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.

Default value: None
operation_config
Required

Operation configuration overrides.

Returns

Type Description
Image,
<xref:msrest.pipeline.ClientRawResponse>

Image or ClientRawResponse if raw=true

Exceptions

Type Description
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

Name Description
list_id
Required
str

List Id of the image list.
content_type
Required
str

The content type.
tag
Required
int

Tag for the image.

Default value: None
label
Required
str

The image label.

Default value: None
data_representation
Required
str
Default value: URL
value
Required
str
Default value: None
custom_headers
Required
dict

headers that will be added to the request

Default value: None
raw
Required
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
Image,
<xref:msrest.pipeline.ClientRawResponse>

Image or ClientRawResponse if raw=true

Exceptions

Type Description
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

Name Description
list_id
Required
str

List Id of the image list.
custom_headers
Required
dict

headers that will be added to the request

Default value: None
raw
Required
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
str,
<xref:msrest.pipeline.ClientRawResponse>

str or ClientRawResponse if raw=true

Exceptions

Type Description
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

Name Description
list_id
Required
str

List Id of the image list.
image_id
Required
str

Id of the image.
custom_headers
Required
dict

headers that will be added to the request

Default value: None
raw
Required
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
str,
<xref:msrest.pipeline.ClientRawResponse>

str or ClientRawResponse if raw=true

Exceptions

Type Description
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

Name Description
list_id
Required
str

List Id of the image list.
custom_headers
Required
dict

headers that will be added to the request

Default value: None
raw
Required
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
ImageIds,
<xref:msrest.pipeline.ClientRawResponse>

ImageIds or ClientRawResponse if raw=true

Exceptions

Type Description
APIErrorException

Attributes

models 

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