az ad app
管理 Microsoft Entra 應用程式。
命令
| 名稱 | Description | 類型 | 狀態 |
|---|---|---|---|
| az ad app create |
建立應用程式。 |
Core | GA |
| az ad app credential |
管理應用程式的密碼或憑證認證。 |
Core | GA |
| az ad app credential delete |
刪除應用程式的密碼或憑證認證。 |
Core | GA |
| az ad app credential list |
列出應用程式的密碼或憑證認證元數據。 (無法擷取密碼或憑證認證的內容。 |
Core | GA |
| az ad app credential reset |
重設應用程式的密碼或憑證認證。 |
Core | GA |
| az ad app delete |
刪除應用程式。 |
Core | GA |
| az ad app federated-credential |
管理應用程式同盟身分識別認證。 |
Core | GA |
| az ad app federated-credential create |
建立應用程式同盟身分識別認證。 |
Core | GA |
| az ad app federated-credential delete |
刪除應用程式同盟身分識別認證。 |
Core | GA |
| az ad app federated-credential list |
列出應用程式同盟身分識別認證。 |
Core | GA |
| az ad app federated-credential show |
顯示應用程式同盟身分識別認證。 |
Core | GA |
| az ad app federated-credential update |
更新應用程式同盟身分識別認證。 |
Core | GA |
| az ad app list |
列出應用程式。 |
Core | GA |
| az ad app owner |
管理應用程式擁有者。 |
Core | GA |
| az ad app owner add |
新增應用程式擁有者。 |
Core | GA |
| az ad app owner list |
列出應用程式擁有者。 |
Core | GA |
| az ad app owner remove |
拿掉應用程式擁有者。 |
Core | GA |
| az ad app permission |
管理應用程式的 OAuth2 許可權。 |
Core | GA |
| az ad app permission add |
新增 API 許可權。 |
Core | GA |
| az ad app permission admin-consent |
透過系統管理員同意授與應用程式 & 委派的許可權。 |
Core | GA |
| az ad app permission delete |
拿掉 API 許可權。 |
Core | GA |
| az ad app permission grant |
將 API 委派的許可權授與應用程式。 |
Core | GA |
| az ad app permission list |
列出應用程式所要求的 API 許可權。 |
Core | GA |
| az ad app permission list-grants |
列出 Oauth2 許可權授與。 |
Core | GA |
| az ad app show |
取得應用程式的詳細數據。 |
Core | GA |
| az ad app update |
更新應用程式。 |
Core | GA |
az ad app create
建立應用程式。
az ad app create --display-name
[--app-roles]
[--enable-access-token-issuance {false, true}]
[--enable-id-token-issuance {false, true}]
[--end-date]
[--identifier-uris]
[--is-fallback-public-client {false, true}]
[--key-display-name]
[--key-type {AsymmetricX509Cert, Password, Symmetric}]
[--key-usage {Sign, Verify}]
[--key-value]
[--optional-claims]
[--public-client-redirect-uris]
[--requested-access-token-version]
[--required-resource-accesses]
[--service-management-reference]
[--sign-in-audience {AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount}]
[--start-date]
[--web-home-page-url]
[--web-redirect-uris]
範例
建立應用程式。
az ad app create --display-name mytestapp
建立可回復至具有 Microsoft Graph 委派許可權 User.Read 的公用客戶端的應用程式
az ad app create --display-name my-public --is-fallback-public-client --required-resource-accesses @manifest.json
("manifest.json" contains the following content)
[{
"resourceAppId": "00000003-0000-0000-c000-000000000000",
"resourceAccess": [
{
"id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
"type": "Scope"
}
]
}]
建立具有角色的應用程式
az ad app create --display-name mytestapp --identifier-uris https://mytestapp.websites.net --app-roles @manifest.json
("manifest.json" contains the following content)
[{
"allowedMemberTypes": [
"User"
],
"description": "Approvers can mark documents as approved",
"displayName": "Approver",
"isEnabled": "true",
"value": "approver"
}]
使用選擇性宣告建立應用程式
az ad app create --display-name mytestapp --optional-claims @manifest.json
("manifest.json" contains the following content)
{
"idToken": [
{
"name": "auth_time",
"essential": false
}
],
"accessToken": [
{
"name": "ipaddr",
"essential": false
}
],
"saml2Token": [
{
"name": "upn",
"essential": false
},
{
"name": "extension_ab603c56068041afb2f6832e2a17e237_skypeId",
"source": "user",
"essential": false
}
]
}
必要參數
應用程式的顯示名稱。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
指派給應用程式的角色集合。 透過應用程式角色指派,這些角色可以指派給與其他應用程式相關聯的使用者、群組或服務主體。 應該是 JSON 檔案路徑或內嵌 JSON 字串。 如需詳細資訊,請參閱範例。
| 屬性 | 值 |
|---|---|
| 參數群組: | JSON property Arguments |
指定此 Web 應用程式是否可以使用 OAuth 2.0 隱含流程來要求存取令牌。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
| 接受的值: | false, true |
指定此 Web 應用程式是否可以使用 OAuth 2.0 隱含流程來要求標識元令牌。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
| 接受的值: | false, true |
認證到期的日期或日期時間(例如 '2017-12-31T11:59:59+00:00' 或 '2017-12-31')。 預設值是目前時間之後的一年。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
以空格分隔的值。 也稱為應用程式識別碼 URI,當應用程式當做資源應用程式使用時,就會設定此值。 identifierUris 會作為您將在 API 程式代碼中參考的範圍前置詞,而且它必須是全域唯一的。 您可以使用提供的預設值 (格式為 api://<application-client-id>),或指定更易讀的 URI,例如 https://contoso.com/api。
指定後援應用程式類型為公用用戶端,例如在行動裝置上執行的已安裝應用程式。 默認值為 false,表示後援應用程式類型是機密用戶端,例如 Web 應用程式。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
索引鍵的易記名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
與應用程式相關聯的金鑰認證類型。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
| 預設值: | AsymmetricX509Cert |
| 接受的值: | AsymmetricX509Cert, Password, Symmetric |
與應用程式相關聯的金鑰認證使用方式。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
| 預設值: | Verify |
| 接受的值: | Sign, Verify |
與應用程式相關聯的金鑰認證值。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
應用程式開發人員可以在其Microsoft Entra 應用程式中設定選擇性宣告,以指定由Microsoft安全性令牌服務傳送至其應用程式的宣告。 如需詳細資訊,請參閱https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims。 應該是 JSON 檔案路徑或內嵌 JSON 字串。 如需詳細資訊,請參閱範例。
| 屬性 | 值 |
|---|---|
| 參數群組: | JSON property Arguments |
以空格分隔的值。 指定傳送使用者權杖以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取權杖的重新導向 URI。
| 屬性 | 值 |
|---|---|
| 參數群組: | publicClient Arguments |
指定此資源所需的存取權杖版本。 所產生的 JWT 與用於要求存取權杖的端點或用戶端無關,這會變更其版本和格式。
| 屬性 | 值 |
|---|---|
| 參數群組: | api Arguments |
指定應用程式需要存取的資源。 這個屬性也會指定每個資源所需的委派許可權和應用程式角色集。 此必要資源的存取設定會驅動同意體驗。 應該是 JSON 檔案路徑或內嵌 JSON 字串。 如需詳細資訊,請參閱範例。
| 屬性 | 值 |
|---|---|
| 參數群組: | JSON property Arguments |
參考來自服務或資產管理資料庫的應用程式或服務連絡資訊。
指定目前應用程式支援的Microsoft帳戶。
| 屬性 | 值 |
|---|---|
| 接受的值: | AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount |
認證生效的日期或日期時間(例如 '2017-01-01T01:00:00+00:00' 或 '2017-01-01')。 預設值為目前時間。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
應用程式的首頁或登陸頁面。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
以空格分隔的值。 指定傳送使用者權杖以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取權杖的重新導向 URI。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az ad app delete
刪除應用程式。
az ad app delete --id
範例
刪除應用程式。 (autogenerated)
az ad app delete --id 00000000-0000-0000-0000-000000000000
必要參數
標識碼 URI、應用程式識別碼或物件識別碼。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az ad app list
列出應用程式。
針對低延遲,預設只會傳回前 100 個,除非您提供篩選自變數或使用 “--all”。
az ad app list [--all]
[--app-id]
[--display-name]
[--filter]
[--identifier-uri]
[--show-mine]
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
列出所有實體,如果大型組織下,預期會有長時間延遲。
應用程式識別碼。
應用程式的顯示名稱。
OData 篩選,例如 --filter “displayname eq 'test' and servicePrincipalType eq 'Application'”。
圖形應用程式識別碼必須是URI格式。
列出目前用戶所擁有的實體。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az ad app show
取得應用程式的詳細數據。
az ad app show --id
範例
使用 appId 取得應用程式的詳細資料。
az ad app show --id 00000000-0000-0000-0000-000000000000
取得標識碼為的應用程式詳細數據。
az ad app show --id 00000000-0000-0000-0000-000000000000
取得識別碼 URI 的應用程式詳細數據。
az ad app show --id api://myapp
必要參數
標識碼 URI、應用程式識別碼或物件識別碼。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
az ad app update
更新應用程式。
az ad app update --id
[--add]
[--app-roles]
[--display-name]
[--enable-access-token-issuance {false, true}]
[--enable-id-token-issuance {false, true}]
[--end-date]
[--force-string]
[--identifier-uris]
[--is-fallback-public-client {false, true}]
[--key-display-name]
[--key-type {AsymmetricX509Cert, Password, Symmetric}]
[--key-usage {Sign, Verify}]
[--key-value]
[--optional-claims]
[--public-client-redirect-uris]
[--remove]
[--requested-access-token-version]
[--required-resource-accesses]
[--service-management-reference]
[--set]
[--sign-in-audience {AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount}]
[--start-date]
[--web-home-page-url]
[--web-redirect-uris]
範例
使用 Microsoft Graph 委派許可權 User.Read 更新應用程式
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --required-resource-accesses @manifest.json
("manifest.json" contains the following content)
[{
"resourceAppId": "00000003-0000-0000-c000-000000000000",
"resourceAccess": [
{
"id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
"type": "Scope"
}
]
}]
宣告應用程式角色
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --app-roles @manifest.json
("manifest.json" contains the following content)
[{
"allowedMemberTypes": [
"User"
],
"description": "Approvers can mark documents as approved",
"displayName": "Approver",
"isEnabled": "true",
"value": "approver"
}]
更新選擇性宣告
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --optional-claims @manifest.json
("manifest.json" contains the following content)
{
"idToken": [
{
"name": "auth_time",
"essential": false
}
],
"accessToken": [
{
"name": "ipaddr",
"essential": false
}
],
"saml2Token": [
{
"name": "upn",
"essential": false
},
{
"name": "extension_ab603c56068041afb2f6832e2a17e237_skypeId",
"source": "user",
"essential": false
}
]
}
將應用程式的群組成員資格宣告更新為 “All”
az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --set groupMembershipClaims=All
必要參數
標識碼 URI、應用程式識別碼或物件識別碼。
選擇性參數
下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。
藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>.
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
| 預設值: | [] |
指派給應用程式的角色集合。 透過應用程式角色指派,這些角色可以指派給與其他應用程式相關聯的使用者、群組或服務主體。 應該是 JSON 檔案路徑或內嵌 JSON 字串。 如需詳細資訊,請參閱範例。
| 屬性 | 值 |
|---|---|
| 參數群組: | JSON property Arguments |
應用程式的顯示名稱。
指定此 Web 應用程式是否可以使用 OAuth 2.0 隱含流程來要求存取令牌。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
| 接受的值: | false, true |
指定此 Web 應用程式是否可以使用 OAuth 2.0 隱含流程來要求標識元令牌。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
| 接受的值: | false, true |
認證到期的日期或日期時間(例如 '2017-12-31T11:59:59+00:00' 或 '2017-12-31')。 預設值是目前時間之後的一年。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
| 預設值: | False |
以空格分隔的值。 也稱為應用程式識別碼 URI,當應用程式當做資源應用程式使用時,就會設定此值。 identifierUris 會作為您將在 API 程式代碼中參考的範圍前置詞,而且它必須是全域唯一的。 您可以使用提供的預設值 (格式為 api://<application-client-id>),或指定更易讀的 URI,例如 https://contoso.com/api。
指定後援應用程式類型為公用用戶端,例如在行動裝置上執行的已安裝應用程式。 默認值為 false,表示後援應用程式類型是機密用戶端,例如 Web 應用程式。
| 屬性 | 值 |
|---|---|
| 接受的值: | false, true |
索引鍵的易記名稱。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
與應用程式相關聯的金鑰認證類型。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
| 預設值: | AsymmetricX509Cert |
| 接受的值: | AsymmetricX509Cert, Password, Symmetric |
與應用程式相關聯的金鑰認證使用方式。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
| 預設值: | Verify |
| 接受的值: | Sign, Verify |
與應用程式相關聯的金鑰認證值。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
應用程式開發人員可以在其Microsoft Entra 應用程式中設定選擇性宣告,以指定由Microsoft安全性令牌服務傳送至其應用程式的宣告。 如需詳細資訊,請參閱https://learn.microsoft.com/azure/active-directory/develop/active-directory-optional-claims。 應該是 JSON 檔案路徑或內嵌 JSON 字串。 如需詳細資訊,請參閱範例。
| 屬性 | 值 |
|---|---|
| 參數群組: | JSON property Arguments |
以空格分隔的值。 指定傳送使用者權杖以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取權杖的重新導向 URI。
| 屬性 | 值 |
|---|---|
| 參數群組: | publicClient Arguments |
從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove> 或 --remove propertyToRemove。
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
| 預設值: | [] |
指定此資源所需的存取權杖版本。 所產生的 JWT 與用於要求存取權杖的端點或用戶端無關,這會變更其版本和格式。
| 屬性 | 值 |
|---|---|
| 參數群組: | api Arguments |
指定應用程式需要存取的資源。 這個屬性也會指定每個資源所需的委派許可權和應用程式角色集。 此必要資源的存取設定會驅動同意體驗。 應該是 JSON 檔案路徑或內嵌 JSON 字串。 如需詳細資訊,請參閱範例。
| 屬性 | 值 |
|---|---|
| 參數群組: | JSON property Arguments |
參考來自服務或資產管理資料庫的應用程式或服務連絡資訊。
指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>.
| 屬性 | 值 |
|---|---|
| 參數群組: | Generic Update Arguments |
| 預設值: | [] |
指定目前應用程式支援的Microsoft帳戶。
| 屬性 | 值 |
|---|---|
| 接受的值: | AzureADMultipleOrgs, AzureADMyOrg, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount |
認證生效的日期或日期時間(例如 '2017-01-01T01:00:00+00:00' 或 '2017-01-01')。 預設值為目前時間。
| 屬性 | 值 |
|---|---|
| 參數群組: | keyCredential Arguments |
應用程式的首頁或登陸頁面。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
以空格分隔的值。 指定傳送使用者權杖以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取權杖的重新導向 URI。
| 屬性 | 值 |
|---|---|
| 參數群組: | web Arguments |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
| 屬性 | 值 |
|---|---|
| 預設值: | False |
輸出格式。
| 屬性 | 值 |
|---|---|
| 預設值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
| 屬性 | 值 |
|---|---|
| 預設值: | False |