az identity federated-credential

ユーザー割り当て ID でフェデレーション ID 資格情報を管理します。

コマンド

名前	説明	型	状態
az identity federated-credential create	既存のユーザー割り当て ID の下にフェデレーション ID 資格情報を作成します。	Core	GA
az identity federated-credential delete	既存のユーザー割り当て ID のフェデレーション ID 資格情報を削除します。	Core	GA
az identity federated-credential list	既存のユーザー割り当て ID の下にあるすべてのフェデレーション ID 資格情報を一覧表示します。	Core	GA
az identity federated-credential show	既存のユーザー割り当て ID の下にフェデレーション ID 資格情報を表示します。	Core	GA
az identity federated-credential update	既存のユーザー割り当て ID でフェデレーション ID 資格情報を更新します。	Core	GA

az identity federated-credential create

既存のユーザー割り当て ID の下にフェデレーション ID 資格情報を作成します。

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]

例

サブジェクトを使用して、特定のユーザー割り当て ID の下にフェデレーション ID 資格情報を作成します。

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

claimsMatchingExpression を使用して、特定のユーザー割り当て ID の下にフェデレーション ID 資格情報を作成します。

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

ID リソースの名前。

--name -n

フェデレーション ID 資格情報リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--audiences

ユーザー割り当てマネージド ID トークンを取得するために Azure に送信されるトークンの aud 値。 フェデレーション資格情報で構成された値と受信トークン内の値は、Azure がアクセス トークンを発行するために正確に一致する必要があります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ	値
Parameter group:	Properties Arguments
規定値:	['api://AzureADTokenExchange']

--claims-matching-expression-value --cme-value

プレビュー

入力方向の要求に一致するワイルドカードベースの式。 --subject と共に使用することはできません。

プロパティ	値
Parameter group:	ClaimsMatchingExpression Arguments

--claims-matching-expression-version --cme-version

プレビュー

式で使用されるクレーム一致式のバージョンを指定します。

プロパティ	値
Parameter group:	ClaimsMatchingExpression Arguments

--issuer

openId は、ユーザー割り当てマネージド ID としてトークンを発行する前に、トークン交換プロトコルで Azure AD がトークン交換プロトコルで使用する ID プロバイダーの発行者のメタデータ URL を接続します。

プロパティ	値
Parameter group:	Properties Arguments

--subject

ユーザー割り当てマネージド ID トークンを取得するために Azure AD に送信されるトークンのサブ値。 フェデレーション資格情報で構成された値と受信トークン内の値は、Azure AD がアクセス トークンを発行するために正確に一致する必要があります。 'subject' または 'claimsMatchingExpression' を定義する必要がありますが、両方を定義する必要はありません。

プロパティ	値
Parameter group:	Properties Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az identity federated-credential delete

既存のユーザー割り当て ID のフェデレーション ID 資格情報を削除します。

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

例

特定のユーザー割り当て ID のフェデレーション ID 資格情報を削除します。

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

必須のパラメーター

--identity-name

ID リソースの名前。

--name -n

フェデレーション ID 資格情報リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az identity federated-credential list

既存のユーザー割り当て ID の下にあるすべてのフェデレーション ID 資格情報を一覧表示します。

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

例

既存のユーザー割り当て ID の下にあるすべてのフェデレーション ID 資格情報を一覧表示します。

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

必須のパラメーター

--identity-name

ID リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ	値
Parameter group:	Pagination Arguments

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

プロパティ	値
Parameter group:	Pagination Arguments

--skiptoken

スキップ トークンは、操作が部分的な結果を返した後もアイテムの取得を続行するために使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skipToken パラメーターが含まれます。

--top

返されるレコードの数。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az identity federated-credential show

既存のユーザー割り当て ID の下にフェデレーション ID 資格情報を表示します。

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

例

特定のユーザー割り当て ID の下にフェデレーション ID 資格情報を表示します。

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

必須のパラメーター

--identity-name

ID リソースの名前。

--name -n

フェデレーション ID 資格情報リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az identity federated-credential update

既存のユーザー割り当て ID でフェデレーション ID 資格情報を更新します。

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]

例

サブジェクトを使用して、特定のユーザー割り当て ID のフェデレーション ID 資格情報を更新します。

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

claimsMatchingExpression を使用して、特定のユーザー割り当て ID のフェデレーション ID 資格情報を更新します。

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

ID リソースの名前。

--name -n

フェデレーション ID 資格情報リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
Parameter group:	Generic Update Arguments

--audiences

ユーザー割り当てマネージド ID トークンを取得するために Azure に送信されるトークンの aud 値。 フェデレーション資格情報で構成された値と受信トークン内の値は、Azure がアクセス トークンを発行するために正確に一致する必要があります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ	値
Parameter group:	Properties Arguments

--claims-matching-expression-value --cme-value

プレビュー

入力方向の要求に一致するワイルドカードベースの式。 --subject と共に使用することはできません。

プロパティ	値
Parameter group:	ClaimsMatchingExpression Arguments

--claims-matching-expression-version --cme-version

プレビュー

式で使用されるクレーム一致式のバージョンを指定します。

プロパティ	値
Parameter group:	ClaimsMatchingExpression Arguments

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
Parameter group:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--issuer

openId は、ユーザー割り当てマネージド ID としてトークンを発行する前に、トークン交換プロトコルで Azure AD がトークン交換プロトコルで使用する ID プロバイダーの発行者のメタデータ URL を接続します。

プロパティ	値
Parameter group:	Properties Arguments

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
Parameter group:	Generic Update Arguments

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
Parameter group:	Generic Update Arguments

--subject

ユーザー割り当てマネージド ID トークンを取得するために Azure AD に送信されるトークンのサブ値。 フェデレーション資格情報で構成された値と受信トークン内の値は、Azure AD がアクセス トークンを発行するために正確に一致する必要があります。 'subject' または 'claimsMatchingExpression' を定義する必要がありますが、両方を定義する必要はありません。

プロパティ	値
Parameter group:	Properties Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False