Skip to content

Commit ed6f818

Browse files
peombwaMicrosoft Graph DevX Tooling
and
Microsoft Graph DevX Tooling
authored
[v1] Weekly Help Docs Generation (#1978)
* Weekly OpenApiDocs Download. * Add generated MgCommandMetadata.json. [run ci] * Docs Generation for 04-27-2023 [run ci] --------- Co-authored-by: Microsoft Graph DevX Tooling <[email protected]>
1 parent 103dc16 commit ed6f818

File tree

6,675 files changed

+293908
-139622
lines changed

Some content is hidden

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

6,675 files changed

+293908
-139622
lines changed

src/Applications/Applications/docs/v1.0-beta/Add-MgApplicationKey.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ schema: 2.0.0
88
# Add-MgApplicationKey
99

1010
## SYNOPSIS
11-
Add a key credential to an application.
12-
This method, along with removeKey, can be used by an application to automate rolling its expiring keys.
13-
As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.
14-
Applications that don’t have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won’t be able to use this service action.
15-
You can use the Update application operation to perform an update instead.
11+
Invoke action addKey
1612

1713
## SYNTAX
1814

@@ -45,11 +41,7 @@ Add-MgApplicationKey -InputObject <IApplicationsIdentity> [-AdditionalProperties
4541
```
4642

4743
## DESCRIPTION
48-
Add a key credential to an application.
49-
This method, along with removeKey, can be used by an application to automate rolling its expiring keys.
50-
As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.
51-
Applications that don’t have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won’t be able to use this service action.
52-
You can use the Update application operation to perform an update instead.
44+
Invoke action addKey
5345

5446
## EXAMPLES
5547

src/Applications/Applications/docs/v1.0-beta/Add-MgApplicationPassword.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Add-MgApplicationPassword
99

1010
## SYNOPSIS
11-
Adds a strong password to an application.
11+
Invoke action addPassword
1212

1313
## SYNTAX
1414

@@ -39,7 +39,7 @@ Add-MgApplicationPassword -InputObject <IApplicationsIdentity> [-AdditionalPrope
3939
```
4040

4141
## DESCRIPTION
42-
Adds a strong password to an application.
42+
Invoke action addPassword
4343

4444
## EXAMPLES
4545

src/Applications/Applications/docs/v1.0-beta/Add-MgServicePrincipalTokenSigningCertificate.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,7 @@ schema: 2.0.0
88
# Add-MgServicePrincipalTokenSigningCertificate
99

1010
## SYNOPSIS
11-
Creates a self-signed signing certificate and returns a selfSignedCertificate object, which is the public part of the generated certificate.
12-
The self-signed signing certificate is composed of the following objects which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with **usage** set to `Sign`.\n + A public key object with **usage** set to `Verify`.\n+ The passwordCredentials object.
13-
All the objects have the same value of **customKeyIdentifier**.
14-
The **passwordCredential** is used to open the PFX file (private key).
15-
It and the associated private key object have the same value of **keyId**.
16-
Once set during creation through the **displayName** property, the subject of the certificate cannot be updated.
17-
The **startDateTime** is set to the same time the certificate is created using the action.
18-
The **endDateTime** can be up to three years after the certificate is created.
11+
Invoke action addTokenSigningCertificate
1912

2013
## SYNTAX
2114

@@ -47,14 +40,7 @@ Add-MgServicePrincipalTokenSigningCertificate -InputObject <IApplicationsIdentit
4740
```
4841

4942
## DESCRIPTION
50-
Creates a self-signed signing certificate and returns a selfSignedCertificate object, which is the public part of the generated certificate.
51-
The self-signed signing certificate is composed of the following objects which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with **usage** set to `Sign`.\n + A public key object with **usage** set to `Verify`.\n+ The passwordCredentials object.
52-
All the objects have the same value of **customKeyIdentifier**.
53-
The **passwordCredential** is used to open the PFX file (private key).
54-
It and the associated private key object have the same value of **keyId**.
55-
Once set during creation through the **displayName** property, the subject of the certificate cannot be updated.
56-
The **startDateTime** is set to the same time the certificate is created using the action.
57-
The **endDateTime** can be up to three years after the certificate is created.
43+
Invoke action addTokenSigningCertificate
5844

5945
## EXAMPLES
6046

src/Applications/Applications/docs/v1.0-beta/Clear-MgApplicationVerifiedPublisher.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ schema: 2.0.0
88
# Clear-MgApplicationVerifiedPublisher
99

1010
## SYNOPSIS
11-
Unset the the verifiedPublisher previously set on an application, removing all verified publisher properties.
12-
For more information, see Publisher verification.
11+
Invoke action unsetVerifiedPublisher
1312

1413
## SYNTAX
1514

@@ -26,8 +25,7 @@ Clear-MgApplicationVerifiedPublisher -InputObject <IApplicationsIdentity> [-Pass
2625
```
2726

2827
## DESCRIPTION
29-
Unset the the verifiedPublisher previously set on an application, removing all verified publisher properties.
30-
For more information, see Publisher verification.
28+
Invoke action unsetVerifiedPublisher
3129

3230
## EXAMPLES
3331

src/Applications/Applications/docs/v1.0-beta/Confirm-MgApplicationMemberGroup.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ schema: 2.0.0
88
# Confirm-MgApplicationMemberGroup
99

1010
## SYNOPSIS
11-
Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member.
12-
This function is transitive.
13-
You can check up to a maximum of 20 groups per request.
14-
This function supports all groups provisioned in Azure AD.
15-
Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.
11+
Invoke action checkMemberGroups
1612

1713
## SYNTAX
1814

@@ -43,11 +39,7 @@ Confirm-MgApplicationMemberGroup -InputObject <IApplicationsIdentity> [-Addition
4339
```
4440

4541
## DESCRIPTION
46-
Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member.
47-
This function is transitive.
48-
You can check up to a maximum of 20 groups per request.
49-
This function supports all groups provisioned in Azure AD.
50-
Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.
42+
Invoke action checkMemberGroups
5143

5244
## EXAMPLES
5345

src/Applications/Applications/docs/v1.0-beta/Confirm-MgServicePrincipalMemberGroup.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ schema: 2.0.0
88
# Confirm-MgServicePrincipalMemberGroup
99

1010
## SYNOPSIS
11-
Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member.
12-
This function is transitive.
13-
You can check up to a maximum of 20 groups per request.
14-
This function supports all groups provisioned in Azure AD.
15-
Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.
11+
Invoke action checkMemberGroups
1612

1713
## SYNTAX
1814

@@ -43,11 +39,7 @@ Confirm-MgServicePrincipalMemberGroup -InputObject <IApplicationsIdentity> [-Add
4339
```
4440

4541
## DESCRIPTION
46-
Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member.
47-
This function is transitive.
48-
You can check up to a maximum of 20 groups per request.
49-
This function supports all groups provisioned in Azure AD.
50-
Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.
42+
Invoke action checkMemberGroups
5143

5244
## EXAMPLES
5345

src/Applications/Applications/docs/v1.0-beta/Find-MgApplicationSynchronizationJobSchemaDirectory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Find-MgApplicationSynchronizationJobSchemaDirectory
99

1010
## SYNOPSIS
11-
Discover the latest schema definition for provisioning to an application.
11+
Invoke action discover
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ Find-MgApplicationSynchronizationJobSchemaDirectory -InputObject <IApplicationsI
2525
```
2626

2727
## DESCRIPTION
28-
Discover the latest schema definition for provisioning to an application.
28+
Invoke action discover
2929

3030
## EXAMPLES
3131

src/Applications/Applications/docs/v1.0-beta/Find-MgApplicationSynchronizationTemplateSchemaDirectory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Find-MgApplicationSynchronizationTemplateSchemaDirectory
99

1010
## SYNOPSIS
11-
Discover the latest schema definition for provisioning to an application.
11+
Invoke action discover
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ Find-MgApplicationSynchronizationTemplateSchemaDirectory -InputObject <IApplicat
2525
```
2626

2727
## DESCRIPTION
28-
Discover the latest schema definition for provisioning to an application.
28+
Invoke action discover
2929

3030
## EXAMPLES
3131

src/Applications/Applications/docs/v1.0-beta/Find-MgServicePrincipalSynchronizationJobSchemaDirectory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Find-MgServicePrincipalSynchronizationJobSchemaDirectory
99

1010
## SYNOPSIS
11-
Discover the latest schema definition for provisioning to an application.
11+
Invoke action discover
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ Find-MgServicePrincipalSynchronizationJobSchemaDirectory -InputObject <IApplicat
2525
```
2626

2727
## DESCRIPTION
28-
Discover the latest schema definition for provisioning to an application.
28+
Invoke action discover
2929

3030
## EXAMPLES
3131

src/Applications/Applications/docs/v1.0-beta/Find-MgServicePrincipalSynchronizationTemplateSchemaDirectory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Find-MgServicePrincipalSynchronizationTemplateSchemaDirectory
99

1010
## SYNOPSIS
11-
Discover the latest schema definition for provisioning to an application.
11+
Invoke action discover
1212

1313
## SYNTAX
1414

@@ -25,7 +25,7 @@ Find-MgServicePrincipalSynchronizationTemplateSchemaDirectory -InputObject <IApp
2525
```
2626

2727
## DESCRIPTION
28-
Discover the latest schema definition for provisioning to an application.
28+
Invoke action discover
2929

3030
## EXAMPLES
3131

src/Applications/Applications/docs/v1.0-beta/Get-MgApplicationById.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ schema: 2.0.0
88
# Get-MgApplicationById
99

1010
## SYNOPSIS
11-
Return the directory objects specified in a list of IDs.
12-
Some common uses for this function are to:
11+
Invoke action getByIds
1312

1413
## SYNTAX
1514

@@ -27,8 +26,7 @@ Get-MgApplicationById
2726
```
2827

2928
## DESCRIPTION
30-
Return the directory objects specified in a list of IDs.
31-
Some common uses for this function are to:
29+
Invoke action getByIds
3230

3331
## EXAMPLES
3432

src/Applications/Applications/docs/v1.0-beta/Get-MgApplicationMemberGroup.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ schema: 2.0.0
88
# Get-MgApplicationMemberGroup
99

1010
## SYNOPSIS
11-
Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of.
12-
This function is transitive.
11+
Invoke action getMemberGroups
1312

1413
## SYNTAX
1514

@@ -40,8 +39,7 @@ Get-MgApplicationMemberGroup -InputObject <IApplicationsIdentity> [-AdditionalPr
4039
```
4140

4241
## DESCRIPTION
43-
Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of.
44-
This function is transitive.
42+
Invoke action getMemberGroups
4543

4644
## EXAMPLES
4745

0 commit comments

Comments
 (0)