From b1a4320aae485bc534a9134638f55a67d56a1c0c Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Wed, 18 Nov 2020 07:43:42 +0000 Subject: [PATCH] CodeGen from PR 11709 in Azure/azure-rest-api-specs Fix support swagger correctness violation (#11709) * updated version, example and schema changes * fixing examples and updating readme files * Update support.json by gangan Removed html tags (kept some
but can remove them as well) moved all of the links to md style. * Update support.json Added CSP and Sev 1 description * Updates from swagger json review * Updates from examples review * prettier check * updating custom words and running prettier * fixing path in readme.go.md * Reverted change from invalid upstream merfe * Fix swagger correctness violation for integer type format * Try to change format to int64 since int32 is flagged as breaking change * Revert "Try to change format to int64 since int32 is flagged as breaking change" This reverts commit cb602d9fcec11dee2a5bed30d86f4d329f74d47b. Co-authored-by: Bhavin Shah Co-authored-by: shahbj79 Co-authored-by: Ganga Narayanan Co-authored-by: Nilay Chheda --- .../azure/mgmt/support/_configuration.py | 2 +- .../azure/mgmt/support/_microsoft_support.py | 2 +- .../azure/mgmt/support/models/_models.py | 115 +++++++++--------- .../azure/mgmt/support/models/_models_py3.py | 115 +++++++++--------- .../operations/_communications_operations.py | 28 ++--- .../mgmt/support/operations/_operations.py | 2 +- .../_problem_classifications_operations.py | 6 +- .../operations/_services_operations.py | 6 +- .../operations/_support_tickets_operations.py | 44 +++---- 9 files changed, 162 insertions(+), 158 deletions(-) diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/_configuration.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/_configuration.py index 4ff32b9dff01..1c3f59c964ec 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/_configuration.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/_configuration.py @@ -21,7 +21,7 @@ class MicrosoftSupportConfiguration(AzureConfiguration): :param credentials: Credentials needed for the client to connect to Azure. :type credentials: :mod:`A msrestazure Credentials object` - :param subscription_id: Azure subscription id + :param subscription_id: Azure subscription Id. :type subscription_id: str :param str base_url: Service URL """ diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/_microsoft_support.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/_microsoft_support.py index 0078a66cd9d1..aa0c15ce314a 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/_microsoft_support.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/_microsoft_support.py @@ -41,7 +41,7 @@ class MicrosoftSupport(SDKClient): :param credentials: Credentials needed for the client to connect to Azure. :type credentials: :mod:`A msrestazure Credentials object` - :param subscription_id: Azure subscription id + :param subscription_id: Azure subscription Id. :type subscription_id: str :param str base_url: Service URL """ diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models.py index 1d0ae958c5db..3f3ce0311e7b 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models.py @@ -18,7 +18,7 @@ class CheckNameAvailabilityInput(Model): All required parameters must be populated in order to send to Azure. - :param name: Required. The resource name to validate + :param name: Required. The resource name to validate. :type name: str :param type: Required. The type of resource. Possible values include: 'Microsoft.Support/supportTickets', 'Microsoft.Support/communications' @@ -84,18 +84,18 @@ class CloudError(Model): class CommunicationDetails(Model): - """Object that represents Communication resource. + """Object that represents a Communication resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/communications' + :ivar type: Type of the resource 'Microsoft.Support/communications'. :vartype type: str :ivar communication_type: Communication type. Possible values include: 'web', 'phone' @@ -106,11 +106,11 @@ class CommunicationDetails(Model): :vartype communication_direction: str or ~azure.mgmt.support.models.CommunicationDirection :param sender: Email address of the sender. This property is required if - called by a service principal + called by a service principal. :type sender: str - :param subject: Required. Subject of the communication + :param subject: Required. Subject of the communication. :type subject: str - :param body: Required. Body of the communication + :param body: Required. Body of the communication. :type body: str :ivar created_date: Time in UTC (ISO 8601 format) when the communication was created. @@ -154,7 +154,7 @@ def __init__(self, **kwargs): class ContactProfile(Model): - """Contact information associated with support ticket. + """Contact information associated with the support ticket. All required parameters must be populated in order to send to Azure. @@ -229,9 +229,9 @@ def __init__(self, **kwargs): class ExceptionResponse(Model): - """The api error. + """The API error. - :param error: The api error details. + :param error: The API error details. :type error: ~azure.mgmt.support.models.ServiceError """ @@ -257,12 +257,12 @@ def __init__(self, deserialize, response, *args): class Operation(Model): - """The operation supported by Microsoft Support RP. + """The operation supported by Microsoft Support resource provider. Variables are only populated by the server, and will be ignored when sending a request. - :ivar name: Operation name: {provider}/{resource}/{operation} + :ivar name: Operation name: {provider}/{resource}/{operation}. :vartype name: str :param display: The object that describes the operation. :type display: ~azure.mgmt.support.models.OperationDisplay @@ -289,14 +289,14 @@ class OperationDisplay(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar description: The description of the operation + :ivar description: The description of the operation. :vartype description: str :ivar operation: The action that users can perform, based on their - permission level + permission level. :vartype operation: str - :ivar provider: Service provider: Microsoft Support + :ivar provider: Service provider: Microsoft Support. :vartype provider: str - :ivar resource: Resource on which the operation is performed + :ivar resource: Resource on which the operation is performed. :vartype resource: str """ @@ -328,11 +328,12 @@ class ProblemClassification(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/problemClassification' + :ivar type: Type of the resource + 'Microsoft.Support/problemClassification'. :vartype type: str :param display_name: Localized name of problem classification. :type display_name: str @@ -386,10 +387,10 @@ class QuotaTicketDetails(Model): request](https://aka.ms/supportrpquotarequestpayload). :param quota_change_request_sub_type: Required for certain quota types - when there is a sub type that you are requesting quota increase for. - Example: Batch + when there is a sub type, such as Batch, for which you are requesting a + quota increase. :type quota_change_request_sub_type: str - :param quota_change_request_version: Quota change request version + :param quota_change_request_version: Quota change request version. :type quota_change_request_version: str :param quota_change_requests: This property is required for providing the region and new quota limits. @@ -416,15 +417,15 @@ class Service(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/services' + :ivar type: Type of the resource 'Microsoft.Support/services'. :vartype type: str - :param display_name: Localized name of Azure service + :param display_name: Localized name of the Azure service. :type display_name: str - :param resource_types: ARM Resource types + :param resource_types: ARM Resource types. :type resource_types: list[str] """ @@ -452,7 +453,7 @@ def __init__(self, **kwargs): class ServiceError(Model): - """The api error details. + """The API error details. Variables are only populated by the server, and will be ignored when sending a request. @@ -524,13 +525,13 @@ class ServiceLevelAgreement(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar start_time: Time in UTC (ISO 8601 format) when service level + :ivar start_time: Time in UTC (ISO 8601 format) when the service level agreement starts. :vartype start_time: datetime - :ivar expiration_time: Time in UTC (ISO 8601 format) when service level - agreement expires. + :ivar expiration_time: Time in UTC (ISO 8601 format) when the service + level agreement expires. :vartype expiration_time: datetime - :ivar sla_minutes: Service Level Agreement in minutes + :ivar sla_minutes: Service Level Agreement in minutes. :vartype sla_minutes: int """ @@ -585,22 +586,21 @@ class SupportTicketDetails(Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/supportTickets' + :ivar type: Type of the resource 'Microsoft.Support/supportTickets'. :vartype type: str - :param support_ticket_id: System generated support ticket id that is + :param support_ticket_id: System generated support ticket Id that is unique. :type support_ticket_id: str :param description: Required. Detailed description of the question or issue. :type description: str :param problem_classification_id: Required. Each Azure service has its own - set of issue category called problem classification that corresponds to - the type of problem you're experiencing. This parameter is the resource id - of ProblemClassification resource. + set of issue categories, also known as problem classification. This + parameter is the unique Id for the type of problem you are experiencing. :type problem_classification_id: str :ivar problem_classification_display_name: Localized name of problem classification. @@ -608,11 +608,12 @@ class SupportTicketDetails(Model): :param severity: Required. A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: - 'Highest critical impact' severity is reserved only to our Premium - customers. Possible values include: 'minimal', 'moderate', 'critical', + 'Highest critical impact', also known as the 'Emergency - Severe impact' + level in the Azure portal is reserved only for our Premium customers. + Possible values include: 'minimal', 'moderate', 'critical', 'highestcriticalimpact' :type severity: str or ~azure.mgmt.support.models.SeverityLevel - :ivar enrollment_id: Enrollment ID associated with the support ticket. + :ivar enrollment_id: Enrollment Id associated with the support ticket. :vartype enrollment_id: str :param require24_x7_response: Indicates if this requires a 24x7 response from Azure. @@ -624,7 +625,7 @@ class SupportTicketDetails(Model): this support ticket. :type service_level_agreement: ~azure.mgmt.support.models.ServiceLevelAgreement - :param support_engineer: Information about support engineer working on + :param support_engineer: Information about the support engineer working on this support ticket. :type support_engineer: ~azure.mgmt.support.models.SupportEngineer :ivar support_plan_type: Support plan type associated with the support @@ -635,18 +636,18 @@ class SupportTicketDetails(Model): :param problem_start_time: Time in UTC (ISO 8601 format) when the problem started. :type problem_start_time: datetime - :param service_id: Required. This is the resource id of the Azure service + :param service_id: Required. This is the resource Id of the Azure service resource associated with the support ticket. :type service_id: str - :ivar service_display_name: Localized name of Azure service. + :ivar service_display_name: Localized name of the Azure service. :vartype service_display_name: str :ivar status: Status of the support ticket. :vartype status: str - :ivar created_date: Time in UTC (ISO 8601 format) when support ticket was - created. + :ivar created_date: Time in UTC (ISO 8601 format) when the support ticket + was created. :vartype created_date: datetime - :ivar modified_date: Time in UTC (ISO 8601 format) when support ticket was - last modified. + :ivar modified_date: Time in UTC (ISO 8601 format) when the support ticket + was last modified. :vartype modified_date: datetime :param technical_ticket_details: Additional ticket details associated with a technical support ticket request. @@ -732,7 +733,7 @@ def __init__(self, **kwargs): class TechnicalTicketDetails(Model): """Additional information for technical support ticket. - :param resource_id: This is the resource id of the Azure service resource + :param resource_id: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. :type resource_id: str @@ -750,25 +751,25 @@ def __init__(self, **kwargs): class UpdateContactProfile(Model): """Contact information associated with the support ticket. - :param first_name: First name + :param first_name: First name. :type first_name: str - :param last_name: Last name + :param last_name: Last name. :type last_name: str :param preferred_contact_method: Preferred contact method. Possible values include: 'email', 'phone' :type preferred_contact_method: str or ~azure.mgmt.support.models.PreferredContactMethod - :param primary_email_address: Primary email address + :param primary_email_address: Primary email address. :type primary_email_address: str :param additional_email_addresses: Email addresses listed will be copied - on any correspondence about the support ticket + on any correspondence about the support ticket. :type additional_email_addresses: list[str] :param phone_number: Phone number. This is required if preferred contact method is phone. :type phone_number: str :param preferred_time_zone: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index - Values](https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values). + Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). :type preferred_time_zone: str :param country: Country of the user. This is the ISO 3166-1 alpha-3 code. :type country: str @@ -810,7 +811,7 @@ def __init__(self, **kwargs): class UpdateSupportTicket(Model): - """Updates severity, ticket status and contact details in the support ticket. + """Updates severity, ticket status, and contact details in the support ticket. :param severity: Severity level. Possible values include: 'minimal', 'moderate', 'critical', 'highestcriticalimpact' diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models_py3.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models_py3.py index 48c8be873275..e81640bec6d8 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models_py3.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/models/_models_py3.py @@ -18,7 +18,7 @@ class CheckNameAvailabilityInput(Model): All required parameters must be populated in order to send to Azure. - :param name: Required. The resource name to validate + :param name: Required. The resource name to validate. :type name: str :param type: Required. The type of resource. Possible values include: 'Microsoft.Support/supportTickets', 'Microsoft.Support/communications' @@ -84,18 +84,18 @@ class CloudError(Model): class CommunicationDetails(Model): - """Object that represents Communication resource. + """Object that represents a Communication resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/communications' + :ivar type: Type of the resource 'Microsoft.Support/communications'. :vartype type: str :ivar communication_type: Communication type. Possible values include: 'web', 'phone' @@ -106,11 +106,11 @@ class CommunicationDetails(Model): :vartype communication_direction: str or ~azure.mgmt.support.models.CommunicationDirection :param sender: Email address of the sender. This property is required if - called by a service principal + called by a service principal. :type sender: str - :param subject: Required. Subject of the communication + :param subject: Required. Subject of the communication. :type subject: str - :param body: Required. Body of the communication + :param body: Required. Body of the communication. :type body: str :ivar created_date: Time in UTC (ISO 8601 format) when the communication was created. @@ -154,7 +154,7 @@ def __init__(self, *, subject: str, body: str, sender: str=None, **kwargs) -> No class ContactProfile(Model): - """Contact information associated with support ticket. + """Contact information associated with the support ticket. All required parameters must be populated in order to send to Azure. @@ -229,9 +229,9 @@ def __init__(self, *, first_name: str, last_name: str, preferred_contact_method, class ExceptionResponse(Model): - """The api error. + """The API error. - :param error: The api error details. + :param error: The API error details. :type error: ~azure.mgmt.support.models.ServiceError """ @@ -257,12 +257,12 @@ def __init__(self, deserialize, response, *args): class Operation(Model): - """The operation supported by Microsoft Support RP. + """The operation supported by Microsoft Support resource provider. Variables are only populated by the server, and will be ignored when sending a request. - :ivar name: Operation name: {provider}/{resource}/{operation} + :ivar name: Operation name: {provider}/{resource}/{operation}. :vartype name: str :param display: The object that describes the operation. :type display: ~azure.mgmt.support.models.OperationDisplay @@ -289,14 +289,14 @@ class OperationDisplay(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar description: The description of the operation + :ivar description: The description of the operation. :vartype description: str :ivar operation: The action that users can perform, based on their - permission level + permission level. :vartype operation: str - :ivar provider: Service provider: Microsoft Support + :ivar provider: Service provider: Microsoft Support. :vartype provider: str - :ivar resource: Resource on which the operation is performed + :ivar resource: Resource on which the operation is performed. :vartype resource: str """ @@ -328,11 +328,12 @@ class ProblemClassification(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/problemClassification' + :ivar type: Type of the resource + 'Microsoft.Support/problemClassification'. :vartype type: str :param display_name: Localized name of problem classification. :type display_name: str @@ -386,10 +387,10 @@ class QuotaTicketDetails(Model): request](https://aka.ms/supportrpquotarequestpayload). :param quota_change_request_sub_type: Required for certain quota types - when there is a sub type that you are requesting quota increase for. - Example: Batch + when there is a sub type, such as Batch, for which you are requesting a + quota increase. :type quota_change_request_sub_type: str - :param quota_change_request_version: Quota change request version + :param quota_change_request_version: Quota change request version. :type quota_change_request_version: str :param quota_change_requests: This property is required for providing the region and new quota limits. @@ -416,15 +417,15 @@ class Service(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/services' + :ivar type: Type of the resource 'Microsoft.Support/services'. :vartype type: str - :param display_name: Localized name of Azure service + :param display_name: Localized name of the Azure service. :type display_name: str - :param resource_types: ARM Resource types + :param resource_types: ARM Resource types. :type resource_types: list[str] """ @@ -452,7 +453,7 @@ def __init__(self, *, display_name: str=None, resource_types=None, **kwargs) -> class ServiceError(Model): - """The api error details. + """The API error details. Variables are only populated by the server, and will be ignored when sending a request. @@ -524,13 +525,13 @@ class ServiceLevelAgreement(Model): Variables are only populated by the server, and will be ignored when sending a request. - :ivar start_time: Time in UTC (ISO 8601 format) when service level + :ivar start_time: Time in UTC (ISO 8601 format) when the service level agreement starts. :vartype start_time: datetime - :ivar expiration_time: Time in UTC (ISO 8601 format) when service level - agreement expires. + :ivar expiration_time: Time in UTC (ISO 8601 format) when the service + level agreement expires. :vartype expiration_time: datetime - :ivar sla_minutes: Service Level Agreement in minutes + :ivar sla_minutes: Service Level Agreement in minutes. :vartype sla_minutes: int """ @@ -585,22 +586,21 @@ class SupportTicketDetails(Model): All required parameters must be populated in order to send to Azure. - :ivar id: Id of the resource + :ivar id: Id of the resource. :vartype id: str - :ivar name: Name of the resource + :ivar name: Name of the resource. :vartype name: str - :ivar type: Type of the resource 'Microsoft.Support/supportTickets' + :ivar type: Type of the resource 'Microsoft.Support/supportTickets'. :vartype type: str - :param support_ticket_id: System generated support ticket id that is + :param support_ticket_id: System generated support ticket Id that is unique. :type support_ticket_id: str :param description: Required. Detailed description of the question or issue. :type description: str :param problem_classification_id: Required. Each Azure service has its own - set of issue category called problem classification that corresponds to - the type of problem you're experiencing. This parameter is the resource id - of ProblemClassification resource. + set of issue categories, also known as problem classification. This + parameter is the unique Id for the type of problem you are experiencing. :type problem_classification_id: str :ivar problem_classification_display_name: Localized name of problem classification. @@ -608,11 +608,12 @@ class SupportTicketDetails(Model): :param severity: Required. A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: - 'Highest critical impact' severity is reserved only to our Premium - customers. Possible values include: 'minimal', 'moderate', 'critical', + 'Highest critical impact', also known as the 'Emergency - Severe impact' + level in the Azure portal is reserved only for our Premium customers. + Possible values include: 'minimal', 'moderate', 'critical', 'highestcriticalimpact' :type severity: str or ~azure.mgmt.support.models.SeverityLevel - :ivar enrollment_id: Enrollment ID associated with the support ticket. + :ivar enrollment_id: Enrollment Id associated with the support ticket. :vartype enrollment_id: str :param require24_x7_response: Indicates if this requires a 24x7 response from Azure. @@ -624,7 +625,7 @@ class SupportTicketDetails(Model): this support ticket. :type service_level_agreement: ~azure.mgmt.support.models.ServiceLevelAgreement - :param support_engineer: Information about support engineer working on + :param support_engineer: Information about the support engineer working on this support ticket. :type support_engineer: ~azure.mgmt.support.models.SupportEngineer :ivar support_plan_type: Support plan type associated with the support @@ -635,18 +636,18 @@ class SupportTicketDetails(Model): :param problem_start_time: Time in UTC (ISO 8601 format) when the problem started. :type problem_start_time: datetime - :param service_id: Required. This is the resource id of the Azure service + :param service_id: Required. This is the resource Id of the Azure service resource associated with the support ticket. :type service_id: str - :ivar service_display_name: Localized name of Azure service. + :ivar service_display_name: Localized name of the Azure service. :vartype service_display_name: str :ivar status: Status of the support ticket. :vartype status: str - :ivar created_date: Time in UTC (ISO 8601 format) when support ticket was - created. + :ivar created_date: Time in UTC (ISO 8601 format) when the support ticket + was created. :vartype created_date: datetime - :ivar modified_date: Time in UTC (ISO 8601 format) when support ticket was - last modified. + :ivar modified_date: Time in UTC (ISO 8601 format) when the support ticket + was last modified. :vartype modified_date: datetime :param technical_ticket_details: Additional ticket details associated with a technical support ticket request. @@ -732,7 +733,7 @@ def __init__(self, *, description: str, problem_classification_id: str, severity class TechnicalTicketDetails(Model): """Additional information for technical support ticket. - :param resource_id: This is the resource id of the Azure service resource + :param resource_id: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. :type resource_id: str @@ -750,25 +751,25 @@ def __init__(self, *, resource_id: str=None, **kwargs) -> None: class UpdateContactProfile(Model): """Contact information associated with the support ticket. - :param first_name: First name + :param first_name: First name. :type first_name: str - :param last_name: Last name + :param last_name: Last name. :type last_name: str :param preferred_contact_method: Preferred contact method. Possible values include: 'email', 'phone' :type preferred_contact_method: str or ~azure.mgmt.support.models.PreferredContactMethod - :param primary_email_address: Primary email address + :param primary_email_address: Primary email address. :type primary_email_address: str :param additional_email_addresses: Email addresses listed will be copied - on any correspondence about the support ticket + on any correspondence about the support ticket. :type additional_email_addresses: list[str] :param phone_number: Phone number. This is required if preferred contact method is phone. :type phone_number: str :param preferred_time_zone: Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index - Values](https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values). + Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). :type preferred_time_zone: str :param country: Country of the user. This is the ISO 3166-1 alpha-3 code. :type country: str @@ -810,7 +811,7 @@ def __init__(self, *, first_name: str=None, last_name: str=None, preferred_conta class UpdateSupportTicket(Model): - """Updates severity, ticket status and contact details in the support ticket. + """Updates severity, ticket status, and contact details in the support ticket. :param severity: Severity level. Possible values include: 'minimal', 'moderate', 'critical', 'highestcriticalimpact' diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_communications_operations.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_communications_operations.py index 81009aa7fc04..49a74c2a6f45 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_communications_operations.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_communications_operations.py @@ -26,7 +26,7 @@ class CommunicationsOperations(object): :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An object model deserializer. - :ivar api_version: Api version. Constant value: "2020-04-01". + :ivar api_version: API version. Constant value: "2020-04-01". """ models = models @@ -42,13 +42,13 @@ def __init__(self, client, config, serializer, deserializer): def check_name_availability( self, support_ticket_name, name, type, custom_headers=None, raw=False, **operation_config): - """Check the availability of a resource name. This API should to be used - to check the uniqueness of the name for adding a new communication to - the support ticket. + """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. - :param support_ticket_name: Support ticket name + :param support_ticket_name: Support ticket name. :type support_ticket_name: str - :param name: The resource name to validate + :param name: The resource name to validate. :type name: str :param type: The type of resource. Possible values include: 'Microsoft.Support/supportTickets', 'Microsoft.Support/communications' @@ -118,10 +118,10 @@ def list( 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.

Support ticket data is available - for 12 months after ticket creation. If a ticket was created more than - 12 months ago, a request for data might cause an error. + for 18 months after ticket creation. If a ticket was created more than + 18 months ago, a request for data might cause an error. - :param support_ticket_name: Support ticket name + :param support_ticket_name: Support ticket name. :type support_ticket_name: str :param top: The number of values to return in the collection. Default is 10 and max is 10. @@ -203,9 +203,9 @@ def get( self, support_ticket_name, communication_name, custom_headers=None, raw=False, **operation_config): """Returns communication details for a support ticket. - :param support_ticket_name: Support ticket name + :param support_ticket_name: Support ticket name. :type support_ticket_name: str - :param communication_name: Communication name + :param communication_name: Communication name. :type communication_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -311,11 +311,11 @@ def create( self, support_ticket_name, communication_name, create_communication_parameters, custom_headers=None, raw=False, polling=True, **operation_config): """Adds a new customer communication to an Azure support ticket. - :param support_ticket_name: Support ticket name + :param support_ticket_name: Support ticket name. :type support_ticket_name: str - :param communication_name: Communication name + :param communication_name: Communication name. :type communication_name: str - :param create_communication_parameters: Communication object + :param create_communication_parameters: Communication object. :type create_communication_parameters: ~azure.mgmt.support.models.CommunicationDetails :param dict custom_headers: headers that will be added to the request diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_operations.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_operations.py index f41866826e83..a27f3c8f79a8 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_operations.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_operations.py @@ -24,7 +24,7 @@ class Operations(object): :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An object model deserializer. - :ivar api_version: Api version. Constant value: "2020-04-01". + :ivar api_version: API version. Constant value: "2020-04-01". """ models = models diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_problem_classifications_operations.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_problem_classifications_operations.py index 0ec28bdd585c..6ab2c4767bbd 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_problem_classifications_operations.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_problem_classifications_operations.py @@ -24,7 +24,7 @@ class ProblemClassificationsOperations(object): :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An object model deserializer. - :ivar api_version: Api version. Constant value: "2020-04-01". + :ivar api_version: API version. Constant value: "2020-04-01". """ models = models @@ -46,7 +46,7 @@ def list( you always have the most recent set of service and problem classification Ids. - :param service_name: Name of Azure service for which the problem + :param service_name: Name of the Azure service for which the problem classifications need to be retrieved. :type service_name: str :param dict custom_headers: headers that will be added to the request @@ -114,7 +114,7 @@ def get( self, service_name, problem_classification_name, custom_headers=None, raw=False, **operation_config): """Get problem classification details for a specific Azure service. - :param service_name: Name of Azure service available for support. + :param service_name: Name of the Azure service available for support. :type service_name: str :param problem_classification_name: Name of problem classification. :type problem_classification_name: str diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_services_operations.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_services_operations.py index b1c59529cfb2..b2e937933093 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_services_operations.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_services_operations.py @@ -24,7 +24,7 @@ class ServicesOperations(object): :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An object model deserializer. - :ivar api_version: Api version. Constant value: "2020-04-01". + :ivar api_version: API version. Constant value: "2020-04-01". """ models = models @@ -45,7 +45,7 @@ def list( service/product as displayed in the **Services** drop-down list on the Azure portal's [New support request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) - page. Always use the service and it's corresponding problem + 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. @@ -111,7 +111,7 @@ def get( self, service_name, custom_headers=None, raw=False, **operation_config): """Gets a specific Azure service for support ticket creation. - :param service_name: Name of Azure service + :param service_name: Name of the Azure service. :type service_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the diff --git a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_support_tickets_operations.py b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_support_tickets_operations.py index 1030c1483595..e77a8a50b74a 100644 --- a/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_support_tickets_operations.py +++ b/sdk/support/azure-mgmt-support/azure/mgmt/support/operations/_support_tickets_operations.py @@ -26,7 +26,7 @@ class SupportTicketsOperations(object): :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An object model deserializer. - :ivar api_version: Api version. Constant value: "2020-04-01". + :ivar api_version: API version. Constant value: "2020-04-01". """ models = models @@ -42,11 +42,11 @@ def __init__(self, client, config, serializer, deserializer): def check_name_availability( self, name, type, custom_headers=None, raw=False, **operation_config): - """Check the availability of a resource name. This API should to be used - to check the uniqueness of the name for support ticket creation for the + """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. - :param name: The resource name to validate + :param name: The resource name to validate. :type name: str :param type: The type of resource. Possible values include: 'Microsoft.Support/supportTickets', 'Microsoft.Support/communications' @@ -113,8 +113,8 @@ def list( filter the support tickets by _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with _nextLink_, using which you can retrieve the next set of support tickets. -

Support ticket data is available for 12 months after ticket - creation. If a ticket was created more than 12 months ago, a request +

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. :param top: The number of values to return in the collection. Default @@ -123,9 +123,10 @@ def list( :param filter: The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). - _Status_ filter can only be used with 'eq' operator. For _CreatedDate_ - filter, the supported operators are 'gt' and 'ge'. When using both - filters, combine them using the logical 'AND'. + _Status_ filter 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'. :type filter: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -195,10 +196,10 @@ def internal_paging(next_link=None): def get( self, support_ticket_name, custom_headers=None, raw=False, **operation_config): """Get ticket details for an Azure subscription. Support ticket data is - available for 12 months after ticket creation. If a ticket was created - more than 12 months ago, a request for data might cause an error. + 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. - :param support_ticket_name: Support ticket name + :param support_ticket_name: Support ticket name. :type support_ticket_name: str :param dict custom_headers: headers that will be added to the request :param bool raw: returns the direct response alongside the @@ -263,9 +264,9 @@ def update( an engineer is actively working on the ticket, send your ticket closure request by sending a note to your engineer. - :param support_ticket_name: Support ticket name + :param support_ticket_name: Support ticket name. :type support_ticket_name: str - :param update_support_ticket: UpdateSupportTicket object + :param update_support_ticket: UpdateSupportTicket object. :type update_support_ticket: ~azure.mgmt.support.models.UpdateSupportTicket :param dict custom_headers: headers that will be added to the request @@ -378,19 +379,20 @@ def create( [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.

Always call the Services and ProblemClassifications API to get the most recent set of services and problem categories - required for support ticket creation.

Adding attachments are + required for support ticket creation.

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.

Providing consent to share diagnostic information with Azure support is currently not supported - via the API. 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.

**Creating a support - ticket for on-behalf-of**: Include _x-ms-authorization-auxiliary_ - header to provide an auxiliary token as per - [this](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). + 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.

**Creating a + support ticket for on-behalf-of**: Include + _x-ms-authorization-auxiliary_ header to provide an auxiliary token as + per + [documentation](https://docs.microsoft.com/azure/azure-resource-manager/management/authenticate-multi-tenant). 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