次の方法で共有


Sign Up Settings - Get

ポータルのサインアップ設定を取得する

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup?api-version=2021-08-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。

serviceName
path True

string

API Management サービスの名前。

正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True

string

クライアント要求で使用される API のバージョン。

応答

名前 説明
200 OK

PortalSignupSettings

Sign-Up 設定。

ヘッダー

ETag: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

ApiManagementPortalSettingsGetSignUp

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup?api-version=2021-08-01

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup",
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "name": "signup",
  "properties": {
    "enabled": true,
    "termsOfService": {
      "text": "Terms of service text.",
      "enabled": true,
      "consentRequired": true
    }
  }
}

定義

名前 説明
ErrorFieldContract

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

ErrorResponse

エラー応答。

PortalSignupSettings

開発者ポータルの設定を Sign-Up します。

TermsOfServiceProperties

サービス契約のプロパティ。

ErrorFieldContract

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

名前 説明
code

string

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

message

string

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

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

PortalSignupSettings

開発者ポータルの設定を Sign-Up します。

名前 説明
id

string

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

name

string

リソースの名前

properties.enabled

boolean

ユーザーが開発者ポータルにサインアップできるようにします。

properties.termsOfService

TermsOfServiceProperties

サービス契約のプロパティ。

type

string

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

TermsOfServiceProperties

サービス契約のプロパティ。

名前 説明
consentRequired

boolean

サービス条件への同意をユーザーに求めます。

enabled

boolean

サインアップ プロセス中に利用規約を表示します。

text

string

サービス条件テキスト。