Skip to content

Commit 362d38b

Browse files
mnorman-msmnorman-ms
authored
Merge branch 'main' into ReviewSetTagsdocumentation
2 parents 2b8de7b + 201bdb7 commit 362d38b

File tree

1,088 files changed

+10085
-2680
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,088 files changed

+10085
-2680
lines changed

‎api-reference/beta/api/announcement-get.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: "Get announcement"
3+
description: "Read the properties and relationships of an announcement object."
4+
author: "garretraziel"
5+
ms.date: 11/20/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-sign-in"
8+
doc_type: apiPageType
9+
---
10+
11+
# Get announcement
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Read the properties of an [announcement](../resources/announcement.md) object.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "announcement-get-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/announcement-get-permissions.md)]
29+
30+
Any user can call these APIs, there are no admin role requirements.
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
GET /identity/productChanges/microsoft.graph.announcement/{id}
40+
```
41+
42+
## Optional query parameters
43+
44+
This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response.
45+
46+
## Request headers
47+
48+
|Name|Description|
49+
|:---|:---|
50+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
51+
52+
## Request body
53+
54+
Don't supply a request body for this method.
55+
56+
## Response
57+
58+
If successful, this method returns a `200 OK` response code and an [announcement](../resources/announcement.md) object in the response body.
59+
60+
## Examples
61+
62+
### Request
63+
64+
The following example shows a request.
65+
<!-- {
66+
"blockType": "request",
67+
"name": "get_announcement"
68+
}
69+
-->
70+
``` http
71+
GET https://graph.microsoft.com/beta/identity/productChanges/microsoft.graph.announcement/ddde9e3b-7ee4-4066-a62e-fb1fc5fb87a1
72+
```
73+
74+
### Response
75+
76+
The following example shows the response.
77+
>**Note:** The response object shown here might be shortened for readability.
78+
<!-- {
79+
"blockType": "response",
80+
"truncated": true,
81+
"@odata.type": "microsoft.graph.announcement"
82+
}
83+
-->
84+
``` http
85+
HTTP/1.1 200 OK
86+
Content-Type: application/json
87+
88+
{
89+
"value": {
90+
"@odata.type": "#microsoft.graph.announcement",
91+
"id": "ddde9e3b-7ee4-4066-a62e-fb1fc5fb87a1",
92+
"changeItemState": "available",
93+
"changeItemService": "mfA",
94+
"tags": [
95+
"Identity Modernization"
96+
],
97+
"systemTags": [
98+
"entra_change_announcements_90days"
99+
],
100+
"documentationUrls": [
101+
"https://learn.microsoft.com/en-us/entra/identity/authentication/how-to-migrate-mfa-server-to-azure-mfa?WT.mc_id=Portal-Microsoft_AAD_IAM"
102+
],
103+
"shortDescription": "Azure Multi-Factor Authentication Server (MFA Server) isn't available for new deployments and will be deprecated. Customers who are using MFA Server should move to using cloud-based Microsoft Entra multifactor authentication.",
104+
"title": "Migrate from MFA Server to Microsoft Entra multifactor authentication",
105+
"description": "*Omitted for brevity*",
106+
"announcementDateTime": "2022-09-30T00:00:00Z",
107+
"targetDateTime": "2024-09-30T00:00:00Z",
108+
"impactLink": null,
109+
"isCustomerActionRequired": true
110+
}
111+
}
112+
```

‎api-reference/beta/api/announcement-list.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: "List announcement objects"
3+
description: "Get a list of the announcement objects and their properties."
4+
author: "garretraziel"
5+
ms.date: 11/20/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-sign-in"
8+
doc_type: apiPageType
9+
---
10+
11+
# List announcement objects
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Get a list of the [announcement](../resources/announcement.md) objects and their properties.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "announcement-list-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/announcement-list-permissions.md)]
29+
30+
Any user can call these APIs, there are no admin role requirements.
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
GET /identity/productChanges/microsoft.graph.announcement
40+
```
41+
42+
## Optional query parameters
43+
44+
This method supports the `$count`, `$filter` (`eq`, `ne`, `in`, `startswith`), `$orderby`, `$search`, `$top` (default page size is 100 items, maximum is 250 items), `$select` and `$skip` [OData query parameters](/graph/query-parameters) to help customize the response.
45+
46+
## Request headers
47+
48+
|Name|Description|
49+
|:---|:---|
50+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
51+
52+
## Request body
53+
54+
Don't supply a request body for this method.
55+
56+
## Response
57+
58+
If successful, this method returns a `200 OK` response code and a collection of [announcement](../resources/announcement.md) objects in the response body.
59+
60+
## Examples
61+
62+
### Request
63+
64+
The following example shows a request.
65+
<!-- {
66+
"blockType": "request",
67+
"name": "list_announcement"
68+
}
69+
-->
70+
``` http
71+
GET https://graph.microsoft.com/beta/identity/productChanges/microsoft.graph.announcement
72+
```
73+
74+
### Response
75+
76+
The following example shows the response.
77+
>**Note:** The response object shown here might be shortened for readability.
78+
<!-- {
79+
"blockType": "response",
80+
"truncated": true,
81+
"@odata.type": "microsoft.graph.announcement"
82+
}
83+
-->
84+
``` http
85+
HTTP/1.1 200 OK
86+
Content-Type: application/json
87+
88+
{
89+
"value": [
90+
{
91+
"@odata.type": "#microsoft.graph.announcement",
92+
"id": "ddde9e3b-7ee4-4066-a62e-fb1fc5fb87a1",
93+
"changeItemState": "available",
94+
"changeItemService": "mfA",
95+
"tags": [
96+
"Identity Modernization"
97+
],
98+
"systemTags": [
99+
"entra_change_announcements_90days"
100+
],
101+
"documentationUrls": [
102+
"https://learn.microsoft.com/en-us/entra/identity/authentication/how-to-migrate-mfa-server-to-azure-mfa?WT.mc_id=Portal-Microsoft_AAD_IAM"
103+
],
104+
"shortDescription": "Azure Multi-Factor Authentication Server (MFA Server) isn't available for new deployments and will be deprecated. Customers who are using MFA Server should move to using cloud-based Microsoft Entra multifactor authentication.",
105+
"title": "Migrate from MFA Server to Microsoft Entra multifactor authentication",
106+
"description": "*Omitted for brevity*",
107+
"announcementDateTime": "2022-09-30T00:00:00Z",
108+
"targetDateTime": "2024-09-30T00:00:00Z",
109+
"impactLink": null,
110+
"isCustomerActionRequired": true
111+
}
112+
]
113+
}
114+
```

‎api-reference/beta/api/appcatalogs-list-teamsapps.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,19 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog.
18-
19-
This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
17+
List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog, including apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
2018

2119
> [!NOTE]
2220
> In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource.
2321
2422
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
2523

24+
> [!IMPORTANT]
25+
> * Currently, this API is only supported in the user context and not in the admin view.
26+
> * The Teams apps that this API returns comply with the app management policies established by the admin.
27+
> * After the Teams apps are published, it typically takes 24-48 hours for the policies to be applied, so some apps might not appear in the API results immediately.
28+
> * For more information, see [App management policies](/microsoftteams/manage-apps#manage-org-wide-app-settings).
29+
2630
## Permissions
2731

2832
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).

‎api-reference/beta/api/authentication-delete-hardwareoathmethods.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ If successful, this method returns a `204 No Content` response code.
8080
### Request
8181

8282
The following example shows a request.
83+
# [HTTP](#tab/http)
8384
<!-- {
8485
"blockType": "request",
8586
"name": "delete_hardwareoathauthenticationmethod"
@@ -89,6 +90,36 @@ The following example shows a request.
8990
DELETE https://graph.microsoft.com/beta/me/authentication/hardwareOathMethods/{hardwareOathAuthenticationMethodId}
9091
```
9192

93+
# [C#](#tab/csharp)
94+
[!INCLUDE [sample-code](../includes/snippets/csharp/delete-hardwareoathauthenticationmethod-csharp-snippets.md)]
95+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
96+
97+
# [CLI](#tab/cli)
98+
[!INCLUDE [sample-code](../includes/snippets/cli/delete-hardwareoathauthenticationmethod-cli-snippets.md)]
99+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
100+
101+
# [Go](#tab/go)
102+
[!INCLUDE [sample-code](../includes/snippets/go/delete-hardwareoathauthenticationmethod-go-snippets.md)]
103+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
104+
105+
# [Java](#tab/java)
106+
[!INCLUDE [sample-code](../includes/snippets/java/delete-hardwareoathauthenticationmethod-java-snippets.md)]
107+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
108+
109+
# [JavaScript](#tab/javascript)
110+
[!INCLUDE [sample-code](../includes/snippets/javascript/delete-hardwareoathauthenticationmethod-javascript-snippets.md)]
111+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
112+
113+
# [PHP](#tab/php)
114+
[!INCLUDE [sample-code](../includes/snippets/php/delete-hardwareoathauthenticationmethod-php-snippets.md)]
115+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
116+
117+
# [Python](#tab/python)
118+
[!INCLUDE [sample-code](../includes/snippets/python/delete-hardwareoathauthenticationmethod-python-snippets.md)]
119+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
120+
121+
---
122+
92123

93124
### Response
94125

‎api-reference/beta/api/authentication-list-hardwareoathmethods.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ If successful, this method returns a `200 OK` response code and a collection of
7878
### Request
7979

8080
The following example shows a request to retrieve the hardware tokens for the signed-in user.
81+
# [HTTP](#tab/http)
8182
<!-- {
8283
"blockType": "request",
8384
"name": "list_hardwareoathauthenticationmethod"
@@ -87,6 +88,36 @@ The following example shows a request to retrieve the hardware tokens for the si
8788
GET https://graph.microsoft.com/beta/me/authentication/hardwareOathMethods
8889
```
8990

91+
# [C#](#tab/csharp)
92+
[!INCLUDE [sample-code](../includes/snippets/csharp/list-hardwareoathauthenticationmethod-csharp-snippets.md)]
93+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
94+
95+
# [CLI](#tab/cli)
96+
[!INCLUDE [sample-code](../includes/snippets/cli/list-hardwareoathauthenticationmethod-cli-snippets.md)]
97+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
98+
99+
# [Go](#tab/go)
100+
[!INCLUDE [sample-code](../includes/snippets/go/list-hardwareoathauthenticationmethod-go-snippets.md)]
101+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
102+
103+
# [Java](#tab/java)
104+
[!INCLUDE [sample-code](../includes/snippets/java/list-hardwareoathauthenticationmethod-java-snippets.md)]
105+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
106+
107+
# [JavaScript](#tab/javascript)
108+
[!INCLUDE [sample-code](../includes/snippets/javascript/list-hardwareoathauthenticationmethod-javascript-snippets.md)]
109+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
110+
111+
# [PHP](#tab/php)
112+
[!INCLUDE [sample-code](../includes/snippets/php/list-hardwareoathauthenticationmethod-php-snippets.md)]
113+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
114+
115+
# [Python](#tab/python)
116+
[!INCLUDE [sample-code](../includes/snippets/python/list-hardwareoathauthenticationmethod-python-snippets.md)]
117+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
118+
119+
---
120+
90121

91122
### Response
92123

‎api-reference/beta/api/authentication-post-hardwareoathmethods.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ If successful, this method returns a `201 Created` response code and a [hardware
8181
### Request
8282

8383
The following example shows a request.
84+
# [HTTP](#tab/http)
8485
<!-- {
8586
"blockType": "request",
8687
"name": "create_hardwareoathauthenticationmethod_from_"
@@ -97,6 +98,36 @@ Content-Type: application/json
9798
}
9899
```
99100

101+
# [C#](#tab/csharp)
102+
[!INCLUDE [sample-code](../includes/snippets/csharp/create-hardwareoathauthenticationmethod-from--csharp-snippets.md)]
103+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
104+
105+
# [CLI](#tab/cli)
106+
[!INCLUDE [sample-code](../includes/snippets/cli/create-hardwareoathauthenticationmethod-from--cli-snippets.md)]
107+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
108+
109+
# [Go](#tab/go)
110+
[!INCLUDE [sample-code](../includes/snippets/go/create-hardwareoathauthenticationmethod-from--go-snippets.md)]
111+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
112+
113+
# [Java](#tab/java)
114+
[!INCLUDE [sample-code](../includes/snippets/java/create-hardwareoathauthenticationmethod-from--java-snippets.md)]
115+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
116+
117+
# [JavaScript](#tab/javascript)
118+
[!INCLUDE [sample-code](../includes/snippets/javascript/create-hardwareoathauthenticationmethod-from--javascript-snippets.md)]
119+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
120+
121+
# [PHP](#tab/php)
122+
[!INCLUDE [sample-code](../includes/snippets/php/create-hardwareoathauthenticationmethod-from--php-snippets.md)]
123+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
124+
125+
# [Python](#tab/python)
126+
[!INCLUDE [sample-code](../includes/snippets/python/create-hardwareoathauthenticationmethod-from--python-snippets.md)]
127+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
128+
129+
---
130+
100131

101132
### Response
102133

0 commit comments

Comments
 (0)