az ad sp

Microsoft Entra サービス プリンシパルを管理します。

コマンド

名前	説明	型	状態
az ad sp create	サービス プリンシパルを作成する。	Core	GA
az ad sp create-for-rbac	アプリケーションとそれに関連付けられているサービス プリンシパルを作成し、必要に応じてサービス プリンシパルの RBAC ロールの割り当てを構成します。	Core	GA
az ad sp credential	サービス プリンシパルのパスワードまたは証明書の資格情報を管理します。	Core	GA
az ad sp credential delete	サービス プリンシパルのパスワードまたは証明書の資格情報を削除します。	Core	GA
az ad sp credential list	サービス プリンシパルのパスワードまたは証明書資格情報のメタデータを一覧表示します。 (パスワードまたは証明書の資格情報の内容は取得できません)。	Core	GA
az ad sp credential reset	サービス プリンシパルのパスワードまたは証明書の資格情報をリセットします。	Core	GA
az ad sp delete	サービス プリンシパルを削除します。	Core	GA
az ad sp list	サービス プリンシパルを一覧表示します。	Core	GA
az ad sp owner	サービス プリンシパルの所有者を管理します。	Core	GA
az ad sp owner list	サービス プリンシパルの所有者を一覧表示します。	Core	GA
az ad sp show	サービス プリンシパルの詳細を取得します。	Core	GA
az ad sp update	サービス プリンシパルを更新します。	Core	GA

az ad sp create

サービス プリンシパルを作成する。

az ad sp create --id

例

サービス プリンシパルを作成する。 (autogenerated)

az ad sp create --id 00000000-0000-0000-0000-000000000000

必須のパラメーター

--id

関連付けられているアプリケーションの識別子 URI、アプリケーション ID、またはオブジェクト ID。

グローバル パラメーター

--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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False

az ad sp create-for-rbac

アプリケーションとそれに関連付けられているサービス プリンシパルを作成し、必要に応じてサービス プリンシパルの RBAC ロールの割り当てを構成します。

出力には、保護する必要がある資格情報が含まれます。 これらの資格情報をコードに含めないようにするか、資格情報をソース管理に確認してください。 As an alternative, consider using managed identities if available to avoid the need to use credentials.

既定では、このコマンドはサービス プリンシパルにロールを割り当てません。 --role と --scopes を使用して特定のロールを割り当て、スコープをリソースまたはリソース グループに絞り込みます。 az role assignment create を使用して、後でこのサービス プリンシパルのロールの割り当てを作成することもできます。 詳細については、ロールの割り当て を追加する 手順を参照してください。

az ad sp create-for-rbac [--cert]
                         [--create-cert]
                         [--create-password {false, true}]
                         [--display-name --name]
                         [--json-auth --sdk-auth {false, true}]
                         [--keyvault]
                         [--role]
                         [--scopes]
                         [--service-management-reference]
                         [--years]

例

ロールを割り当てずに作成します。

az ad sp create-for-rbac

カスタム表示名を使用して作成します。

az ad sp create-for-rbac -n MyApp

指定したスコープで共同作成者ロールの割り当てを使用して作成します。 現在のサブスクリプション ID を取得するには、'az account show --query id --output tsv' を実行します。

az ad sp create-for-rbac -n MyApp --role Contributor --scopes /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup2

パスワード資格情報は作成しないでください。

az ad sp create-for-rbac --create-password false

自己署名証明書を使用して作成します。

az ad sp create-for-rbac --create-cert

既存の証明書文字列を使用して作成します。

az ad sp create-for-rbac --cert "MIICoT..."

既存の証明書ファイルを使用して作成します。

az ad sp create-for-rbac --cert "@~/cert.pem"
`cert.pem` contains the following content
-----BEGIN CERTIFICATE-----  <<< this line is optional
MIICoT...
-----END CERTIFICATE-----    <<< this line is optional

自己署名証明書を使用して作成し、Azure Key Vault 内に格納します。

az ad sp create-for-rbac --keyvault MyVault --cert CertName --create-cert

Azure Key Vault で既存の証明書を使用して作成します。

az ad sp create-for-rbac --keyvault MyVault --cert CertName

省略可能のパラメーター

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

--cert

資格情報に使用する証明書。 --keyvault,と共に使用する場合は、使用または作成する証明書の名前を示します。 それ以外の場合は、PEM または DER 形式のパブリック証明書文字列を指定します。 @{path} を使用してファイルから読み込みます。 秘密キーは含めないでください。

プロパティ	値
Parameter group:	keyCredential Arguments

--create-cert

資格情報に使用する自己署名証明書を作成します。 この証明書に対する読み取り/書き込みアクセス許可を持っているのは、現在の OS ユーザーだけです。 --keyvault と共に使用して、Key Vault に証明書を作成します。 それ以外の場合は、証明書がローカルに作成されます。

プロパティ	値
Parameter group:	keyCredential Arguments
規定値:	False

--create-password

アプリケーションでパスワード資格情報 (シークレット) を作成します。 これが既定の動作です。 この引数を false に設定すると、パスワード資格情報の作成が無効になります。

プロパティ	値
Parameter group:	Credential Arguments
規定値:	True
指定可能な値:	false, true

--display-name --name -n

サービス プリンシパルの表示名。 存在しない場合は、既定で azure-cli-%Y-%m-%d-%H-%M-%S サフィックスが作成時刻になります。

--json-auth --sdk-auth

非推奨

オプション '--sdk-auth' は非推奨となり、今後のリリースで削除される予定です。

JSON 形式のクラウド エンドポイントと共にサービス プリンシパルの資格情報を出力します。

プロパティ	値
指定可能な値:	false, true

--keyvault

証明書の作成または取得に使用する KeyVault の名前または ID。

プロパティ	値
Parameter group:	keyCredential Arguments

--role

サービス プリンシパルのロール。

--scopes

サービス プリンシパルのロールの割り当てが適用されるスコープのスペース区切りの一覧。例: subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM。

--service-management-reference

作成したアプリケーションの serviceManagementReference プロパティを設定します。 サービスまたは資産管理データベースからアプリケーションまたはサービスの連絡先情報を参照します。

--years

資格情報が有効になる年数。 既定値: 1 年。

プロパティ	値
Parameter group:	Credential 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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False

az ad sp delete

サービス プリンシパルを削除します。

az ad sp delete --id

例

サービス プリンシパルを削除します。

az ad sp delete --id 00000000-0000-0000-0000-000000000000

必須のパラメーター

--id

サービス プリンシパル名またはオブジェクト ID。

グローバル パラメーター

--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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False

az ad sp list

サービス プリンシパルを一覧表示します。

待機時間が短い場合、既定では、フィルター引数を指定するか "--all" を使用しない限り、最初の 100 のみが返されます。

az ad sp list [--all]
              [--display-name]
              [--filter]
              [--show-mine]
              [--spn]

省略可能のパラメーター

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

--all

大規模な組織の下で長い遅延が予想される、すべてのエンティティを一覧表示します。

--display-name

オブジェクトの表示名またはそのプレフィックス。

--filter

OData フィルター(例: --filter "displayname eq 'test' and servicePrincipalType eq 'Application')。

--show-mine

現在のユーザーが所有するエンティティを一覧表示します。

--spn

サービス プリンシパル名。

グローバル パラメーター

--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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False

az ad sp show

サービス プリンシパルの詳細を取得します。

az ad sp show --id

例

appId を使用してサービス プリンシパルの詳細を取得します。

az ad sp show --id 00000000-0000-0000-0000-000000000000

ID を使用してサービス プリンシパルの詳細を取得します。

az ad sp show --id 00000000-0000-0000-0000-000000000000

識別子 URI を持つサービス プリンシパルの詳細を取得します。

az ad sp show --id api://myapp

必須のパラメーター

--id

サービス プリンシパル名またはオブジェクト ID。

グローバル パラメーター

--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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False

az ad sp update

サービス プリンシパルを更新します。

az ad sp update --id
                [--add]
                [--force-string]
                [--remove]
                [--set]

例

サービス プリンシパルの更新 (自動生成)

az ad sp update --id 00000000-0000-0000-0000-000000000000 --set groupMembershipClaims=All

必須のパラメーター

--id

サービス プリンシパル名またはオブジェクト ID。

省略可能のパラメーター

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
規定値:	[]

--force-string

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

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

--remove

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--set

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

プロパティ	値
Parameter group:	Generic Update 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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False