Skip to content

Commit

Permalink
Merge pull request #195 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history
azure updates
  • Loading branch information
jeffreyaven authored Oct 16, 2024
2 parents 52e3b84 + 90fd1f7 commit 3efb788
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Creates, updates, deletes, gets or lists a <code>skus</code> resource.
| <CopyableCode code="resourceType" /> | `string` | The type of resource the SKU applies to. |
| <CopyableCode code="restrictions" /> | `array` | The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. |
| <CopyableCode code="size" /> | `string` | The Size of the SKU. |
| <CopyableCode code="tier" /> | `string` | Specifies the tier of virtual machines in a scale set. Possible Values: **Standard** **Basic** |
| <CopyableCode code="tier" /> | `string` | Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic** |

## Methods
| Name | Accessible by | Required Params | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Creates, updates, deletes, gets or lists a <code>resource_skus</code> resource.
| <CopyableCode code="resourceType" /> | `string` | The type of resource the SKU applies to. |
| <CopyableCode code="restrictions" /> | `array` | The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. |
| <CopyableCode code="size" /> | `string` | The Size of the SKU. |
| <CopyableCode code="tier" /> | `string` | Specifies the tier of virtual machines in a scale set. Possible Values: **Standard** **Basic** |
| <CopyableCode code="tier" /> | `string` | Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic** |

## Methods
| Name | Accessible by | Required Params | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Creates, updates, deletes, gets or lists a <code>node_type_skus</code> resource.
| Name | Datatype | Description |
|:-----|:---------|:------------|
| <CopyableCode code="capacity" /> | `object` | Provides information about how node type can be scaled. |
| <CopyableCode code="resourceType" /> | `string` | The type of resource the sku applies to. Value: Microsoft.ServiceFabric/managedClusters/nodeTypes. |
| <CopyableCode code="resourceType" /> | `string` | The type of resource the sku applies to. <br /><br />Value: Microsoft.ServiceFabric/managedClusters/nodeTypes. |
| <CopyableCode code="sku" /> | `object` | Describes a node type supported sku. |

## Methods
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ Creates, updates, deletes, gets or lists a <code>communications</code> resource.
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="communicationName, subscriptionId, supportTicketName" /> | Returns communication details for a support ticket. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="subscriptionId, supportTicketName" /> | Lists all communications (attachments not included) for a support ticket. </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. 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. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="subscriptionId, supportTicketName" /> | Lists all communications (attachments not included) for a support ticket. <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. <br/><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. |
| <CopyableCode code="create" /> | `INSERT` | <CopyableCode code="communicationName, subscriptionId, supportTicketName" /> | Adds a new customer communication to an Azure support ticket. |
| <CopyableCode code="check_name_availability" /> | `EXEC` | <CopyableCode code="subscriptionId, supportTicketName, data__name, data__type" /> | 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. |

## `SELECT` examples

Lists all communications (attachments not included) for a support ticket. </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. 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.
Lists all communications (attachments not included) for a support ticket. <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. <br/><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.

<Tabs
defaultValue="view"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ Creates, updates, deletes, gets or lists a <code>communications_no_subscriptions
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="communicationName, supportTicketName" /> | Returns communication details for a support ticket. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="supportTicketName" /> | Lists all communications (attachments not included) for a support ticket. </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. 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. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="supportTicketName" /> | Lists all communications (attachments not included) for a support ticket. <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. <br/><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. |
| <CopyableCode code="create" /> | `INSERT` | <CopyableCode code="communicationName, supportTicketName" /> | Adds a new customer communication to an Azure support ticket. |
| <CopyableCode code="check_name_availability" /> | `EXEC` | <CopyableCode code="supportTicketName, data__name, data__type" /> | 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. |

## `SELECT` examples

Lists all communications (attachments not included) for a support ticket. </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. 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.
Lists all communications (attachments not included) for a support ticket. <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. <br/><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.

<Tabs
defaultValue="view"
Expand Down
8 changes: 4 additions & 4 deletions docs/azure-docs/providers/azure/support/tickets/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ Creates, updates, deletes, gets or lists a <code>tickets</code> resource.
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="subscriptionId, supportTicketName" /> | 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. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="subscriptionId" /> | 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. 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. |
| <CopyableCode code="create" /> | `INSERT` | <CopyableCode code="subscriptionId, supportTicketName" /> | Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [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 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. 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 solution provider (CSP) partner tenant. |
| <CopyableCode code="update" /> | `UPDATE` | <CopyableCode code="subscriptionId, supportTicketName" /> | This API allows you to update the severity level, ticket status, advanced diagnostic consent and your contact information in the support ticket. 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. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="subscriptionId" /> | 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/><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. |
| <CopyableCode code="create" /> | `INSERT` | <CopyableCode code="subscriptionId, supportTicketName" /> | Creates a new support ticket for Subscription and Service limits (Quota), Technical, Billing, and Subscription Management issues for the specified subscription. Learn the [prerequisites](https://aka.ms/supportAPI) required to create a support ticket.<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.<br/><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.<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.<br/><br/>**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 solution provider (CSP) partner tenant. |
| <CopyableCode code="update" /> | `UPDATE` | <CopyableCode code="subscriptionId, supportTicketName" /> | This API allows you to update the severity level, ticket status, advanced diagnostic consent and your contact information in the support ticket.<br/><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. |
| <CopyableCode code="check_name_availability" /> | `EXEC` | <CopyableCode code="subscriptionId, data__name, data__type" /> | 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. |

## `SELECT` examples

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. 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.
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/><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.

<Tabs
defaultValue="view"
Expand Down
Loading

0 comments on commit 3efb788

Please sign in to comment.