Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds graph schemaextension set command
- Loading branch information
Showing
5 changed files
with
774 additions
and
0 deletions.
There are no files selected for viewing
59 changes: 59 additions & 0 deletions
59
docs/manual/docs/cmd/graph/schemaextension/schemaextension-set.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# graph schemaextension set | ||
|
||
Updates a Microsoft Graph schema extension | ||
|
||
## Usage | ||
|
||
```sh | ||
graph schemaextension set [options] | ||
``` | ||
|
||
## Options | ||
|
||
Option|Description | ||
------|----------- | ||
`--help`|output usage information | ||
`-i, --id <id>`|The unique identifier for the schema extension definition | ||
`--owner`|The ID of the Azure AD application that is the owner of the schema extension | ||
`-d, --description [description]`|Description of the schema extension | ||
`-s, --status [status]`|The lifecycle state of the schema extension. Accepted values are 'Available' or 'Deprecated' | ||
`-t, --targetTypes [targetTypes]`|Comma-separated list of Microsoft Graph resource types the schema extension targets | ||
`-p, --properties [properties]`|The collection of property names and types that make up the schema extension definition formatted as a JSON string | ||
`-o, --output [output]`|Output type. `json|text`. Default `text` | ||
`--verbose`|Runs command with verbose logging | ||
`--debug`|Runs command with debug logging | ||
|
||
## Remarks | ||
|
||
The lifecycle state of the schema extension. The initial state upon creation is `InDevelopment`. | ||
Possible states transitions are from `InDevelopment` to `Available` and `Available` to `Deprecated`. | ||
The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list. | ||
When specifying the JSON string of properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _properties_ option: `{"Foo":"Bar"}`, | ||
you should specify the value as <code>\`"{""Foo"":""Bar""}"\`</code>. | ||
In addition, when using PowerShell, you should use the `--%` argument. | ||
|
||
## Examples | ||
|
||
Update the description of a schema extension | ||
|
||
```sh | ||
graph schemaextension set --id MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --description "My schema extension" | ||
``` | ||
|
||
Update the target types and properties of a schema extension | ||
|
||
```sh | ||
graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --targetTypes Group --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\` | ||
``` | ||
Update the properties of a schema extension in PowerShell | ||
```PowerShell | ||
graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties --% \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\` | ||
``` | ||
|
||
Change the status of a schema extension to 'Available' | ||
|
||
```sh | ||
graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --status Available | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.