Subscription - Create Or Update

  • リファレンス
Service:
API Management
API Version:
2022-08-01

指定された製品に対する指定されたユーザーのサブスクリプションを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2022-08-01
With optional parameters: 
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2022-08-01&appType={appType}

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid
 path True

string

サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。

Regex pattern: ^[^*#&+:<>?]+$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。
appType
 query

AppType

ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値は従来のパブリッシャー ポータルです。
notify
 query

boolean

サブスクリプションの状態の変更を通知します。

  • false の場合は、サブスクリプションの状態の変更に関する電子メール通知を送信しないでください
  • true の場合は、サブスクリプションの状態の変更に関する電子メール通知を送信します

要求ヘッダー

名前 必須 型 説明
If-Match

string

エンティティの ETag。 エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

名前 必須 型 説明
properties.displayName True

string

サブスクリプションの名前。
properties.scope True

string

/products/{productId} や /apis または /apis/{apiId} などのスコープ。
properties.allowTracing

boolean

トレースを有効にできるかどうかを判断します
properties.ownerId

string

サブスクリプションが /users/{userId} の形式で作成されているユーザー (ユーザー ID パス)
properties.primaryKey

string

プライマリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。
properties.secondaryKey

string

セカンダリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。
properties.state

SubscriptionState

初期サブスクリプションの状態。 値が指定されていない場合は、送信済み状態でサブスクリプションが作成されます。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

応答

名前 型 説明
200 OK

SubscriptionContract

ユーザーは既に製品をサブスクライブしています。

Headers

ETag: string
201 Created

SubscriptionContract

ユーザーは正常に製品にサブスクライブされました。

Headers

ETag: string
Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

ApiManagementCreateSubscription

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2022-08-01

{
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}
Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

定義

名前 説明
AppType

ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値は従来のパブリッシャー ポータルです。
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
SubscriptionContract

サブスクリプションの詳細。
SubscriptionCreateParameters

サブスクリプションの作成の詳細。
SubscriptionState

サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

AppType

ユーザー作成要求を送信するアプリケーションの種類を決定します。 既定値は従来のパブリッシャー ポータルです。

名前 型 説明
developerPortal

string

ユーザー作成要求は、新しい開発者ポータルによって送信されました。
portal

string

ユーザー作成要求は、レガシ開発者ポータルから送信されました。

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

SubscriptionContract

サブスクリプションの詳細。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.allowTracing

boolean

トレースが有効になっているかどうかを判断します
properties.createdDate

string

サブスクリプションの作成日。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.displayName

string

サブスクリプションの名前。サブスクリプションに名前がない場合は null。
properties.endDate

string

サブスクリプションが取り消されたか期限切れになった日付。 この設定は監査のみを目的としており、サブスクリプションは自動的に取り消されません。 サブスクリプションのライフサイクルは、 プロパティを使用 state して管理できます。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.expirationDate

string

サブスクリプションの有効期限。 この設定は監査のみを目的としており、サブスクリプションの有効期限は自動的には切れていません。 サブスクリプションのライフサイクルは、 プロパティを使用 state して管理できます。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.notificationDate

string

今後のサブスクリプションの有効期限の通知日。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.ownerId

string

サブスクリプション所有者のユーザー リソース識別子。 値は、/users/{userId} 形式の有効な相対 URL です。{userId} はユーザー識別子です。
properties.primaryKey

string

サブスクリプションの主キー。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
properties.scope

string

/products/{productId} や /apis または /apis/{apiId} などのスコープ。
properties.secondaryKey

string

サブスクリプションのセカンダリ キー。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
properties.startDate

string

サブスクリプションのアクティブ化日。 この設定は監査のみを目的としており、サブスクリプションは自動的にアクティブ化されません。 サブスクリプションのライフサイクルは、 プロパティを使用 state して管理できます。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.state

SubscriptionState

サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。
properties.stateComment

string

状態が 'rejected' に変更されたときに管理者によって追加されるオプションのサブスクリプション コメント。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

サブスクリプションの作成の詳細。

名前 型 説明
properties.allowTracing

boolean

トレースを有効にできるかどうかを判断します
properties.displayName

string

サブスクリプションの名前。
properties.ownerId

string

サブスクリプションが /users/{userId} の形式で作成されているユーザー (ユーザー ID パス)
properties.primaryKey

string

プライマリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。
properties.scope

string

/products/{productId} や /apis または /apis/{apiId} などのスコープ。
properties.secondaryKey

string

セカンダリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。
properties.state

SubscriptionState

初期サブスクリプションの状態。 値が指定されていない場合は、送信済み状態でサブスクリプションが作成されます。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

SubscriptionState

サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

名前 型 説明
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string