你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az identity federated-credential

在用户分配的标识下管理联合标识凭据。

命令

名称 说明 类型 Status
az identity federated-credential create

在现有用户分配的标识下创建联合标识凭据。

核心 乔治亚州
az identity federated-credential delete

在现有用户分配的标识下删除联合标识凭据。

核心 乔治亚州
az identity federated-credential list

列出现有用户分配标识下的所有联合标识凭据。

核心 乔治亚州
az identity federated-credential show

在现有用户分配的标识下显示联合标识凭据。

核心 乔治亚州
az identity federated-credential update

在现有用户分配的标识下更新联合标识凭据。

核心 乔治亚州

az identity federated-credential create

在现有用户分配的标识下创建联合标识凭据。

az identity federated-credential create --identity-name
                                        --name
                                        --resource-group
                                        [--audiences]
                                        [--claims-matching-expression-value --cme-value]
                                        [--claims-matching-expression-version --cme-version]
                                        [--issuer]
                                        [--subject]

示例

使用使用者在特定用户分配的标识下创建联合标识凭据。

az identity federated-credential create --name myFicName --identity-name myIdentityName --resource-group myResourceGroup --issuer myIssuer --subject mySubject --audiences myAudiences

使用 claimsMatchingExpression 在特定用户分配的标识下创建联合标识凭据。

az identity federated-credential create --name myFicName --identity-name myIdentityName --resource-group myResourceGroup --issuer myIssuer --claims-matching-expression-version 1 --claims-matching-expression-value "claims['sub'] eq 'foo'" --audiences myAudiences

必需参数

--identity-name

标识资源的名称。

--name -n

联合标识凭据资源的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--audiences

发送到 Azure 的令牌中的 aud 值,用于获取用户分配的托管标识令牌。 在联合凭据中配置的值和传入令牌中的值必须完全匹配,Azure 才能颁发访问令牌。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--claims-matching-expression-value --cme-value
预览

用于匹配传入声明的基于通配符的表达式。 不能与 --subject 一起使用。

--claims-matching-expression-version --cme-version
预览

指定表达式中使用的声明匹配表达式的版本。

--issuer

在颁发令牌作为用户分配的托管标识之前,Azure AD 在令牌交换协议中用于验证令牌的 openId 连接元数据 URL。

--subject

发送到 Azure AD 的令牌中的子值,用于获取用户分配的托管标识令牌。 在联合凭据中配置的值和传入令牌中的值必须完全匹配,Azure AD 才能颁发访问令牌。 必须定义“subject”或“claimsMatchingExpression”,但不能同时定义这两者。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az identity federated-credential delete

在现有用户分配的标识下删除联合标识凭据。

az identity federated-credential delete --identity-name
                                        --name
                                        --resource-group
                                        [--yes]

示例

删除特定用户分配的标识下的联合标识凭据。

az identity federated-credential delete --name myFicName --identity-name myIdentityName --resource-group myResourceGroup

必需参数

--identity-name

标识资源的名称。

--name -n

联合标识凭据资源的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--yes -y

不要提示确认。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az identity federated-credential list

列出现有用户分配标识下的所有联合标识凭据。

az identity federated-credential list --identity-name
                                      --resource-group
                                      [--max-items]
                                      [--next-token]
                                      [--skiptoken]
                                      [--top]

示例

列出现有用户分配标识下的所有联合标识凭据。

az identity federated-credential list --identity-name myIdentityName --resource-group myResourceGroup

必需参数

--identity-name

标识资源的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的 --next-token 参数中提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

--skiptoken

跳过令牌用于在作返回部分结果后继续检索项。 如果以前的响应包含 nextLink 元素,则 nextLink 元素的值将包含一个 skipToken 参数,该参数指定用于后续调用的起点。

--top

要返回的记录数。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az identity federated-credential show

在现有用户分配的标识下显示联合标识凭据。

az identity federated-credential show --identity-name
                                      --name
                                      --resource-group

示例

显示特定用户分配的标识下的联合标识凭据。

az identity federated-credential show --name myFicName --identity-name myIdentityName --resource-group myResourceGroup

必需参数

--identity-name

标识资源的名称。

--name -n

联合标识凭据资源的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

az identity federated-credential update

在现有用户分配的标识下更新联合标识凭据。

az identity federated-credential update --identity-name
                                        --name
                                        --resource-group
                                        [--add]
                                        [--audiences]
                                        [--claims-matching-expression-value --cme-value]
                                        [--claims-matching-expression-version --cme-version]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--issuer]
                                        [--remove]
                                        [--set]
                                        [--subject]

示例

使用使用者在特定用户分配的标识下更新联合标识凭据。

az identity federated-credential update --identity-name myIdentityName --name myFicName --resource-group myResourceGroup --issuer myIssuer --subject mySubject --audiences myAudiences

使用 claimsMatchingExpression 在特定用户分配的标识下更新联合标识凭据。

az identity federated-credential update --identity-name myIdentityName --name myFicName --resource-group myResourceGroup --issuer myIssuer --claims-matching-expression-version 1 --claims-matching-expression-value "claims['sub'] eq 'foo'" --audiences myAudiences

必需参数

--identity-name

标识资源的名称。

--name -n

联合标识凭据资源的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>

--audiences

发送到 Azure 的令牌中的 aud 值,用于获取用户分配的托管标识令牌。 在联合凭据中配置的值和传入令牌中的值必须完全匹配,Azure 才能颁发访问令牌。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--claims-matching-expression-value --cme-value
预览

用于匹配传入声明的基于通配符的表达式。 不能与 --subject 一起使用。

--claims-matching-expression-version --cme-version
预览

指定表达式中使用的声明匹配表达式的版本。

--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--issuer

在颁发令牌作为用户分配的托管标识之前,Azure AD 在令牌交换协议中用于验证令牌的 openId 连接元数据 URL。

--remove

从列表中删除属性或元素。 示例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>

--subject

发送到 Azure AD 的令牌中的子值,用于获取用户分配的托管标识令牌。 在联合凭据中配置的值和传入令牌中的值必须完全匹配,Azure AD 才能颁发访问令牌。 必须定义“subject”或“claimsMatchingExpression”,但不能同时定义这两者。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。