-
Notifications
You must be signed in to change notification settings - Fork 463
/
github.yml
128 lines (127 loc) · 5 KB
/
github.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
### YamlMime:AzureCLIGroup
uid: az_webapp_auth_github
name: az webapp auth github
extensionInformation: >-
> [!NOTE]
> This reference is part of the **authV2** extension for the Azure CLI (version 2.23.0 or higher). The extension will automatically install the first time you run an **az webapp auth github** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
Manage webapp authentication and authorization of the GitHub identity provider.
status: GA
sourceType: Extension
directCommands:
- uid: az_webapp_auth_github_show
name: az webapp auth github show
summary: |-
Show the authentication settings for the GitHub identity provider.
status: GA
sourceType: Extension
syntax: >-
az webapp auth github show [--ids]
[--name]
[--resource-group]
[--slot]
[--subscription]
examples:
- summary: |-
Show the authentication settings for the GitHub identity provider. (autogenerated)
syntax: az webapp auth github show --name MyWebApp --resource-group MyResourceGroup
optionalParameters:
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name -n
summary: |-
Name of the web app.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --slot -s
summary: |-
The name of the slot. Default to the productions slot if not specified.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- uid: az_webapp_auth_github_update
name: az webapp auth github update
summary: |-
Update the client id and client secret for the GitHub identity provider.
status: GA
sourceType: Extension
syntax: >-
az webapp auth github update [--client-id]
[--client-secret]
[--client-secret-setting-name]
[--ids]
[--name]
[--resource-group]
[--scopes]
[--slot]
[--subscription]
[--yes]
examples:
- summary: |-
Update the client id and client secret for the GitHub identity provider.
syntax: >-
az webapp auth github update -g myResourceGroup --name MyWebApp \
--client-id my-client-id --client-secret very_secret_password
optionalParameters:
- name: --client-id
summary: |-
The Client ID of the app used for login.
- name: --client-secret
summary: |-
The client secret.
- name: --client-secret-setting-name --secret-setting
summary: |-
The app setting name that contains the client secret.
- name: --ids
summary: |-
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
- name: --name -n
summary: |-
Name of the web app.
- name: --resource-group -g
summary: |-
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- name: --scopes
summary: |-
A list of the scopes that should be requested while authenticating.
- name: --slot -s
summary: |-
The name of the slot. Default to the productions slot if not specified.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --yes -y
defaultValue: "False"
summary: |-
Do not prompt for confirmation.
commands:
- az_webapp_auth_github_show
- az_webapp_auth_github_update
globalParameters:
- name: --debug
summary: |-
Increase logging verbosity to show all debug logs.
- name: --help -h
summary: |-
Show this help message and exit.
- name: --only-show-errors
summary: |-
Only show errors, suppressing warnings.
- name: --output -o
defaultValue: "json"
parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
summary: |-
Output format.
- name: --query
summary: |-
JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
summary: |-
Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
summary: |-
Increase logging verbosity. Use --debug for full debug logs.
metadata:
description: Manage webapp authentication and authorization of the GitHub identity provider.