アプリケーションを更新する

[アーティクル]
07/07/2022

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

アプリケーションオブジェクトのプロパティを更新します。

重要

PATCH を使用して passwordCredential を設定することはサポートされていません。 addPassword メソッドと removePassword メソッドを使用して、アプリケーションのパスワードまたはシークレットを更新します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Application.ReadWrite.All, Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント)	Application.ReadWrite.All
アプリケーション	Application.ReadWrite.OwnedBy、Application.ReadWrite.All、Directory.ReadWrite.All

HTTP 要求

{id} をアプリケーションオブジェクトの id に置き換えます。Azure portal では、Object ID とも呼ばれます。

PATCH /applications/{id}

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。
Content-Type	application/json. Required.

要求本文

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

プロパティ	型	説明
api	apiApplication	Web API を実装するアプリケーションの設定を指定します。
appRoles	appRole コレクション	アプリケーションで宣言できるアプリケーションロールのコレクションです。これらのロールは、ユーザー、グループ、サービスプリンシパルなどに割り当てることができます。 null 許容型ではありません。
displayName	String	アプリケーションの表示名。
groupMembershipClaims	String	アプリケーションが想定するユーザーまたは OAuth 2.0 アクセストークンで発行されたグループ要求を構成します。この属性を設定するには、次のいずれかの有効な文字列値を使用します。 `None` `SecurityGroup`: セキュリティグループと Azure Active Directory (Azure AD) ロールの場合 `All`: サインインしているユーザーがメンバーになっているすべてのセキュリティグループ、配布グループ、および Azure AD ディレクトリロールが取得されます
identifierUris	String collection	アプリケーションを識別する URI。Azure AD テナント内、またはアプリケーションがマルチテナントの場合は検証済みのカスタムドメイン内で識別します。詳細については、「Application オブジェクトとサービスプリンシパルオブジェクト」を参照してください。複数値プロパティのフィルター式には any 演算子が必要です。 null 許容型ではありません。
info	informationalUrl	アプリのマーケティング、サポート、利用規約、プライバシーに関する声明の URL など、アプリケーションの基本的なプロファイル情報。サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。詳細については、「登録済みの Azure AD アプリの利用規約とプライバシーに関する声明を追加する」を参照してください。
isFallbackPublicClient	Boolean	モバイルデバイスで実行するインストール済みアプリケーションなど、フォールバックアプリケーションの種類をパブリッククライアントとして指定します。既定値は `false`、フォールバックアプリケーションの種類が Web アプリなどの機密クライアントであることを意味します。 Azure AD でクライアントアプリケーションの種類 (リダイレクト URI を指定せずに構成されている ROPC フローなど) を特定できないシナリオがあります。このような場合、Azure AD は、このプロパティの値に基づいてアプリケーションの種類を解釈します。
keyCredentials	keyCredential コレクション	アプリケーションに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。
logo	Stream	アプリケーションのメインロゴです。null 許容型ではありません。
onPremisesPublishing	onPremisesPublishing	オンプレミスアプリケーションの Azure AD アプリケーションプロキシを構成するためのプロパティのセットを表します。このプロパティは、アプリケーションが作成された後にのみ設定でき、他のアプリケーションプロパティと同じ要求で更新することはできません。
optionalClaims	optionalClaims	アプリケーションの開発者は、Azure AD アプリにオプションの要求を構成することで、Microsoft セキュリティトークンサービスから送信されるトークンに含める要求を指定できます。詳細については、省略可能な要求を参照してください。
parentalControlSettings	parentalControlSettings	アプリケーションにおける、保護者による制限設定を指定します。
publicClient	publicClientApplication	デスクトップやモバイルデバイスなど、インストールされているクライアントの設定を指定します。
requiredResourceAccess	requiredResourceAccess コレクション	アプリケーションがアクセスする必要があるリソースを指定します。このプロパティでは、各リソースに必要な委任されたアクセス許可とアプリケーションロールのセットも指定します。必要なリソースへのアクセスに対するこの構成によって、同意エクスペリエンスが促進されます。 50 を超えるリソースサービス (API) を構成できます。 2021 年 10 月中旬以降は、必要なアクセス許可の合計が 400 を超えることはできません。 null 許容ではありません。
samlMetadataUrl	String	サービスによりフェデレーション用の SAML メタデータが公開されている URL。このプロパティは、シングルテナントアプリケーションに対してのみ有効です。
signInAudience	String	現在のアプリケーションでサポートされている Microsoft アカウントを指定します。サポートされている値は次のとおりです。 `AzureADMyOrg`: 組織の Azure AD テナント (つまり、シングルテナント) で Microsoft の職場または学校アカウントを持つユーザー `AzureADMultipleOrgs`: いずれかの組織の Azure AD テナント (つまり、シングルテナント) で Microsoft の職場または学校アカウントを持つユーザー `AzureADandPersonalMicrosoftAccount`: 個人の Microsoft アカウントを持つユーザー、またはいずれかの組織の Azure AD テナントで職場または学校のアカウントを持つユーザー
SPA	spaApplication	サインアウト URL、認証コードとアクセストークンのリダイレクト URI など、シングルページアプリケーションの設定を指定します。
tags	String collection	アプリケーションを分類および識別するために使用できるカスタム文字列です。null 許容型ではありません。
tokenEncryptionKeyId	String	keyCredentials コレクションにある公開キーの keyId を指定します。構成されている場合、Azure AD から発行されるすべてのトークンは、このプロパティが指すキーを使用して暗号化されます。暗号化されたトークンを受け取るアプリケーションコードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。
uniqueName	String	アプリケーションに代替識別子として割り当て可能な一意の識別子。変更できません。読み取り専用です。
Web	webApplication	Web アプリケーションの設定を指定します。
SPA	spaApplication	サインアウト URL、認証コードとアクセストークンのリダイレクト URI など、シングルページアプリケーションの設定を指定します。
windows	windowsApplication	Microsoft Windows を実行し、Microsoft Store または Xbox ゲームストアで公開されているアプリの設定を指定します。承認コードとアクセストークン用のパッケージ SID とリダイレクト URI が含まれています。

応答

成功した場合、このメソッドは応答コードを 204 No Content 返し、応答本文には何も返しません。

例

要求

以下は、要求の例です。

PATCH https://graph.microsoft.com/beta/applications/{id}
Content-type: application/json

{
  "displayName": "New display name"
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var application = new Application
{
    DisplayName = "New display name"
};

await graphClient.Applications["{application-id}"]
    .Request()
    .UpdateAsync(application);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
    authProvider,
};

const client = Client.init(options);

const application = {
  displayName: 'New display name'
};

await client.api('/applications/{id}')
    .version('beta')
    .update(application);

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/applications/{id}"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphApplication *application = [[MSGraphApplication alloc] init];
[application setDisplayName:@"New display name"];

NSError *error;
NSData *applicationData = [application getSerializedDataWithError:&error];
[urlRequest setHTTPBody:applicationData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Application application = new Application();
application.displayName = "New display name";

graphClient.applications("{id}")
    .buildRequest()
    .patch(application);

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewApplication()
displayName := "New display name"
requestBody.SetDisplayName(&displayName)
applicationId := "application-id"
graphClient.ApplicationsById(&applicationId).Patch(requestBody)

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Applications

$params = @{
    DisplayName = "New display name"
}

Update-MgApplication -ApplicationId $applicationId -BodyParameter $params

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

HTTP/1.1 204 No Content

アプリケーションを更新する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック