azure.mgmt.support.operations module¶
- class azure.mgmt.support.operations.ChatTranscriptsNoSubscriptionOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’schat_transcripts_no_subscriptionattribute.- get(support_ticket_name: str, chat_transcript_name: str, **kwargs: Any) ChatTranscriptDetails[source]¶
Returns chatTranscript details for a no subscription support ticket.
- Parameters:
- Returns:
ChatTranscriptDetails or the result of cls(response)
- Return type:
- Raises:
- list(support_ticket_name: str, **kwargs: Any) Iterable[ChatTranscriptDetails][source]¶
Lists all chat transcripts for a support ticket.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
- Returns:
An iterator like instance of either ChatTranscriptDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.ChatTranscriptsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’schat_transcriptsattribute.- get(support_ticket_name: str, chat_transcript_name: str, **kwargs: Any) ChatTranscriptDetails[source]¶
Returns chatTranscript details for a support ticket under a subscription.
- Parameters:
- Returns:
ChatTranscriptDetails or the result of cls(response)
- Return type:
- Raises:
- list(support_ticket_name: str, **kwargs: Any) Iterable[ChatTranscriptDetails][source]¶
Lists all chat transcripts for a support ticket under subscription.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
- Returns:
An iterator like instance of either ChatTranscriptDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.CommunicationsNoSubscriptionOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’scommunications_no_subscriptionattribute.- begin_create(support_ticket_name: str, communication_name: str, create_communication_parameters: _models.CommunicationDetails, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.CommunicationDetails][source]¶
- begin_create(support_ticket_name: str, communication_name: str, create_communication_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.CommunicationDetails]
Adds a new customer communication to an Azure support ticket.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
communication_name (str) – Communication name. Required.
create_communication_parameters (CommunicationDetails or IO[bytes]) – Communication object. Is either a CommunicationDetails type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either CommunicationDetails or the result of cls(response)
- Return type:
- Raises:
- check_name_availability(support_ticket_name: str, check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput[source]¶
- check_name_availability(support_ticket_name: str, check_name_availability_input: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
check_name_availability_input (CheckNameAvailabilityInput or IO[bytes]) – Input to check. Is either a CheckNameAvailabilityInput type or a IO[bytes] type. Required.
- Returns:
CheckNameAvailabilityOutput or the result of cls(response)
- Return type:
- Raises:
- get(support_ticket_name: str, communication_name: str, **kwargs: Any) CommunicationDetails[source]¶
Returns communication details for a support ticket.
- Parameters:
- Returns:
CommunicationDetails or the result of cls(response)
- Return type:
- Raises:
- list(support_ticket_name: str, top: int | None = None, filter: str | None = None, **kwargs: Any) Iterable[CommunicationDetails][source]¶
Lists all communications (attachments not included) for a support ticket.
<br/>`</br> You can also filter support ticket communications by *CreatedDate* or *CommunicationType* using the $filter parameter. The only type of communication supported today is *Web*. Output will be a paged result with *nextLink*, using which you can retrieve the next set of Communication results. :code:`<br/>:code:`<br/>`Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.- Parameters:
support_ticket_name (str) – Support ticket name. Required.
top (int) – The number of values to return in the collection. Default is 10 and max is 10. Default value is None.
filter (str) – The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals (‘eq’) operator and createdDate supports Greater Than (‘gt’) and Greater Than or Equals (‘ge’) operators. You may combine the CommunicationType and CreatedDate filters by Logical And (‘and’) operator. Default value is None.
- Returns:
An iterator like instance of either CommunicationDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.CommunicationsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’scommunicationsattribute.- begin_create(support_ticket_name: str, communication_name: str, create_communication_parameters: _models.CommunicationDetails, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.CommunicationDetails][source]¶
- begin_create(support_ticket_name: str, communication_name: str, create_communication_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.CommunicationDetails]
Adds a new customer communication to an Azure support ticket.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
communication_name (str) – Communication name. Required.
create_communication_parameters (CommunicationDetails or IO[bytes]) – Communication object. Is either a CommunicationDetails type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either CommunicationDetails or the result of cls(response)
- Return type:
- Raises:
- check_name_availability(support_ticket_name: str, check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput[source]¶
- check_name_availability(support_ticket_name: str, check_name_availability_input: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
check_name_availability_input (CheckNameAvailabilityInput or IO[bytes]) – Input to check. Is either a CheckNameAvailabilityInput type or a IO[bytes] type. Required.
- Returns:
CheckNameAvailabilityOutput or the result of cls(response)
- Return type:
- Raises:
- get(support_ticket_name: str, communication_name: str, **kwargs: Any) CommunicationDetails[source]¶
Returns communication details for a support ticket.
- Parameters:
- Returns:
CommunicationDetails or the result of cls(response)
- Return type:
- Raises:
- list(support_ticket_name: str, top: int | None = None, filter: str | None = None, **kwargs: Any) Iterable[CommunicationDetails][source]¶
Lists all communications (attachments not included) for a support ticket.
<br/>`</br> You can also filter support ticket communications by *CreatedDate* or *CommunicationType* using the $filter parameter. The only type of communication supported today is *Web*. Output will be a paged result with *nextLink*, using which you can retrieve the next set of Communication results. :code:`<br/>:code:`<br/>`Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.- Parameters:
support_ticket_name (str) – Support ticket name. Required.
top (int) – The number of values to return in the collection. Default is 10 and max is 10. Default value is None.
filter (str) – The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals (‘eq’) operator and createdDate supports Greater Than (‘gt’) and Greater Than or Equals (‘ge’) operators. You may combine the CommunicationType and CreatedDate filters by Logical And (‘and’) operator. Default value is None.
- Returns:
An iterator like instance of either CommunicationDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.FileWorkspacesNoSubscriptionOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’sfile_workspaces_no_subscriptionattribute.- create(file_workspace_name: str, **kwargs: Any) FileWorkspaceDetails[source]¶
Creates a new file workspace.
- Parameters:
file_workspace_name (str) – File workspace name. Required.
- Returns:
FileWorkspaceDetails or the result of cls(response)
- Return type:
- Raises:
- get(file_workspace_name: str, **kwargs: Any) FileWorkspaceDetails[source]¶
Gets details for a specific file workspace.
- Parameters:
file_workspace_name (str) – File Workspace Name. Required.
- Returns:
FileWorkspaceDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.FileWorkspacesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’sfile_workspacesattribute.- create(file_workspace_name: str, **kwargs: Any) FileWorkspaceDetails[source]¶
Creates a new file workspace for the specified subscription.
- Parameters:
file_workspace_name (str) – File workspace name. Required.
- Returns:
FileWorkspaceDetails or the result of cls(response)
- Return type:
- Raises:
- get(file_workspace_name: str, **kwargs: Any) FileWorkspaceDetails[source]¶
Gets details for a specific file workspace in an Azure subscription.
- Parameters:
file_workspace_name (str) – File Workspace Name. Required.
- Returns:
FileWorkspaceDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.FilesNoSubscriptionOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’sfiles_no_subscriptionattribute.- create(file_workspace_name: str, file_name: str, create_file_parameters: _models.FileDetails, *, content_type: str = 'application/json', **kwargs: Any) _models.FileDetails[source]¶
- create(file_workspace_name: str, file_name: str, create_file_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.FileDetails
Creates a new file under a workspace.
- Parameters:
file_workspace_name (str) – File workspace name. Required.
file_name (str) – File name. Required.
create_file_parameters (FileDetails or IO[bytes]) – Create file object. Is either a FileDetails type or a IO[bytes] type. Required.
- Returns:
FileDetails or the result of cls(response)
- Return type:
- Raises:
- get(file_workspace_name: str, file_name: str, **kwargs: Any) FileDetails[source]¶
Returns details of a specific file in a work space.
- Parameters:
- Returns:
FileDetails or the result of cls(response)
- Return type:
- Raises:
- list(file_workspace_name: str, **kwargs: Any) Iterable[FileDetails][source]¶
Lists all the Files information under a workspace for an Azure subscription.
- Parameters:
file_workspace_name (str) – File Workspace Name. Required.
- Returns:
An iterator like instance of either FileDetails or the result of cls(response)
- Return type:
- Raises:
- upload(file_workspace_name: str, file_name: str, upload_file: _models.UploadFile, *, content_type: str = 'application/json', **kwargs: Any) None[source]¶
- upload(file_workspace_name: str, file_name: str, upload_file: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) None
This API allows you to upload content to a file.
- Parameters:
file_workspace_name (str) – File WorkspaceName. Required.
file_name (str) – File Name. Required.
upload_file (UploadFile or IO[bytes]) – UploadFile object. Is either a UploadFile type or a IO[bytes] type. Required.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.FilesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’sfilesattribute.- create(file_workspace_name: str, file_name: str, create_file_parameters: _models.FileDetails, *, content_type: str = 'application/json', **kwargs: Any) _models.FileDetails[source]¶
- create(file_workspace_name: str, file_name: str, create_file_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.FileDetails
Creates a new file under a workspace for the specified subscription.
- Parameters:
file_workspace_name (str) – File workspace name. Required.
file_name (str) – File name. Required.
create_file_parameters (FileDetails or IO[bytes]) – Create file object. Is either a FileDetails type or a IO[bytes] type. Required.
- Returns:
FileDetails or the result of cls(response)
- Return type:
- Raises:
- get(file_workspace_name: str, file_name: str, **kwargs: Any) FileDetails[source]¶
Returns details of a specific file in a work space.
- Parameters:
- Returns:
FileDetails or the result of cls(response)
- Return type:
- Raises:
- list(file_workspace_name: str, **kwargs: Any) Iterable[FileDetails][source]¶
Lists all the Files information under a workspace for an Azure subscription.
- Parameters:
file_workspace_name (str) – File Workspace Name. Required.
- Returns:
An iterator like instance of either FileDetails or the result of cls(response)
- Return type:
- Raises:
- upload(file_workspace_name: str, file_name: str, upload_file: _models.UploadFile, *, content_type: str = 'application/json', **kwargs: Any) None[source]¶
- upload(file_workspace_name: str, file_name: str, upload_file: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) None
This API allows you to upload content to a file.
- Parameters:
file_workspace_name (str) – File WorkspaceName. Required.
file_name (str) – File Name. Required.
upload_file (UploadFile or IO[bytes]) – UploadFile object. Is either a UploadFile type or a IO[bytes] type. Required.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.Operations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’soperationsattribute.- list(**kwargs: Any) Iterable[Operation][source]¶
This lists all the available Microsoft Support REST API operations.
- Returns:
An iterator like instance of either Operation or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.ProblemClassificationsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’sproblem_classificationsattribute.- get(service_name: str, problem_classification_name: str, **kwargs: Any) ProblemClassification[source]¶
Get problem classification details for a specific Azure service.
- Parameters:
- Returns:
ProblemClassification or the result of cls(response)
- Return type:
- Raises:
- list(service_name: str, **kwargs: Any) Iterable[ProblemClassification][source]¶
Lists all the problem classifications (categories) available for a specific Azure service. Always use the service and problem classifications obtained programmatically. This practice ensures that you always have the most recent set of service and problem classification Ids.
- Parameters:
service_name (str) – Name of the Azure service for which the problem classifications need to be retrieved. Required.
- Returns:
An iterator like instance of either ProblemClassification or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.ServicesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’sservicesattribute.- get(service_name: str, **kwargs: Any) Service[source]¶
Gets a specific Azure service for support ticket creation.
- Parameters:
service_name (str) – Name of the Azure service. Required.
- Returns:
Service or the result of cls(response)
- Return type:
- Raises:
- list(**kwargs: Any) Iterable[Service][source]¶
Lists all the Azure services available for support ticket creation. For Technical issues, select the Service Id that maps to the Azure service/product as displayed in the Services drop-down list on the Azure portal’s New support request page. Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation. This practice ensures that you always have the most recent set of service and problem classification Ids.
- Returns:
An iterator like instance of either Service or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.SupportTicketsNoSubscriptionOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’ssupport_tickets_no_subscriptionattribute.- begin_create(support_ticket_name: str, create_support_ticket_parameters: _models.SupportTicketDetails, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.SupportTicketDetails][source]¶
- begin_create(support_ticket_name: str, create_support_ticket_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.SupportTicketDetails]
Creates a new support ticket for Billing, and Subscription Management issues. Learn the prerequisites required to create a support ticket.:code:<br/>
<br/>`Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.:code:`<br/>:code:`<br/>`Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the `Manage support ticket <https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest>`_ page in the Azure portal, select the support ticket, and use the file upload control to add a new file.:code:<br/><br/>`Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.:code:`<br/><br/>.- Parameters:
support_ticket_name (str) – Support ticket name. Required.
create_support_ticket_parameters (SupportTicketDetails or IO[bytes]) – Support ticket request payload. Is either a SupportTicketDetails type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- check_name_availability(check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput[source]¶
- check_name_availability(check_name_availability_input: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput
Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
- Parameters:
check_name_availability_input (CheckNameAvailabilityInput or IO[bytes]) – Input to check. Is either a CheckNameAvailabilityInput type or a IO[bytes] type. Required.
- Returns:
CheckNameAvailabilityOutput or the result of cls(response)
- Return type:
- Raises:
- get(support_ticket_name: str, **kwargs: Any) SupportTicketDetails[source]¶
Gets details for a specific support ticket. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
- Returns:
SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- list(top: int | None = None, filter: str | None = None, **kwargs: Any) Iterable[SupportTicketDetails][source]¶
Lists all the support tickets.
<br/><br/>`You can also filter the support tickets by :code:`<i>Status</i>,<i>CreatedDate</i>, ,<i>ServiceId</i>, and<i>ProblemClassificationId</i>using the $filter parameter. Output will be a paged result with<i>nextLink</i>, using which you can retrieve the next set of support tickets.<br/>:code:`<br/>`Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.- Parameters:
top (int) – The number of values to return in the collection. Default is 25 and max is 100. Default value is None.
filter (str) – The filter to apply on the operation. We support ‘odata v4.0’ filter semantics.
<a target='_blank' href='https://docs.microsoft.com/odata/concepts/queryoptions-overview'>Learn more</a><br/><i>Status</i>,<i>ServiceId</i>, and<i>ProblemClassificationId</i>filters can only be used with ‘eq’ operator. For<i>CreatedDate</i>filter, the supported operators are ‘gt’ and ‘ge’. When using both filters, combine them using the logical ‘AND’. Default value is None.
- Returns:
An iterator like instance of either SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- update(support_ticket_name: str, update_support_ticket: _models.UpdateSupportTicket, *, content_type: str = 'application/json', **kwargs: Any) _models.SupportTicketDetails[source]¶
- update(support_ticket_name: str, update_support_ticket: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.SupportTicketDetails
This API allows you to update the severity level, ticket status, and your contact information in the support ticket.:code:<br/>:code:`<br/>`Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
update_support_ticket (UpdateSupportTicket or IO[bytes]) – UpdateSupportTicket object. Is either a UpdateSupportTicket type or a IO[bytes] type. Required.
- Returns:
SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶
- class azure.mgmt.support.operations.SupportTicketsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
MicrosoftSupport’ssupport_ticketsattribute.- begin_create(support_ticket_name: str, create_support_ticket_parameters: _models.SupportTicketDetails, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.SupportTicketDetails][source]¶
- begin_create(support_ticket_name: str, create_support_ticket_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.SupportTicketDetails]
Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the prerequisites required to create a support ticket.:code:<br/>
<br/>`Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories required for support ticket creation.:code:`<br/>:code:`<br/>`Adding attachments is not currently supported via the API. To add a file to an existing support ticket, visit the `Manage support ticket <https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/managesupportrequest>`_ page in the Azure portal, select the support ticket, and use the file upload control to add a new file.:code:<br/><br/>`Providing consent to share diagnostic information with Azure support is currently not supported via the API. The Azure support engineer working on your ticket will reach out to you for consent if your issue requires gathering diagnostic information from your Azure resources.:code:`<br/><br/>Creating a support ticket for on-behalf-of: Include x-ms-authorization-auxiliary header to provide an auxiliary token as per documentation. The primary token will be from the tenant for whom a support ticket is being raised against the subscription, i.e. Cloud solution provider (CSP) customer tenant. The auxiliary token will be from the Cloud solution provider (CSP) partner tenant.- Parameters:
support_ticket_name (str) – Support ticket name. Required.
create_support_ticket_parameters (SupportTicketDetails or IO[bytes]) – Support ticket request payload. Is either a SupportTicketDetails type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- check_name_availability(check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput[source]¶
- check_name_availability(check_name_availability_input: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.CheckNameAvailabilityOutput
Check the availability of a resource name. This API should be used to check the uniqueness of the name for support ticket creation for the selected subscription.
- Parameters:
check_name_availability_input (CheckNameAvailabilityInput or IO[bytes]) – Input to check. Is either a CheckNameAvailabilityInput type or a IO[bytes] type. Required.
- Returns:
CheckNameAvailabilityOutput or the result of cls(response)
- Return type:
- Raises:
- get(support_ticket_name: str, **kwargs: Any) SupportTicketDetails[source]¶
Get ticket details for an Azure subscription. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
- Returns:
SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- list(top: int | None = None, filter: str | None = None, **kwargs: Any) Iterable[SupportTicketDetails][source]¶
Lists all the support tickets for an Azure subscription. You can also filter the support tickets by Status, CreatedDate, ServiceId, and ProblemClassificationId using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets.
<br/>:code:`<br/>`Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.- Parameters:
top (int) – The number of values to return in the collection. Default is 25 and max is 100. Default value is None.
filter (str) – The filter to apply on the operation. We support ‘odata v4.0’ filter semantics. Learn more. Status, ServiceId, and ProblemClassificationId filters can only be used with Equals (‘eq’) operator. For CreatedDate filter, the supported operators are Greater Than (‘gt’) and Greater Than or Equals (‘ge’). When using both filters, combine them using the logical ‘AND’. Default value is None.
- Returns:
An iterator like instance of either SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- update(support_ticket_name: str, update_support_ticket: _models.UpdateSupportTicket, *, content_type: str = 'application/json', **kwargs: Any) _models.SupportTicketDetails[source]¶
- update(support_ticket_name: str, update_support_ticket: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.SupportTicketDetails
This API allows you to update the severity level, ticket status, advanced diagnostic consent and your contact information in the support ticket.:code:<br/>:code:`<br/>`Note: The severity levels cannot be changed if a support ticket is actively being worked upon by an Azure support engineer. In such a case, contact your support engineer to request severity update by adding a new communication using the Communications API.
- Parameters:
support_ticket_name (str) – Support ticket name. Required.
update_support_ticket (UpdateSupportTicket or IO[bytes]) – UpdateSupportTicket object. Is either a UpdateSupportTicket type or a IO[bytes] type. Required.
- Returns:
SupportTicketDetails or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.support.models' from '/mnt/vss/_work/1/s/sdk/support/azure-mgmt-support/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/support/models/__init__.py'>¶