Sign Up Settings - Update
Sign-Up ayarlarını güncelleştirin.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup?api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Regex pattern: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
If-Match | True |
string |
Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
properties.enabled |
boolean |
Kullanıcıların bir geliştirici portalına kaydolmasına izin verin. |
properties.termsOfService |
Hizmet sözleşmesi özellikleri. |
Yanıtlar
Name | Tür | Description |
---|---|---|
204 No Content |
Sign-Up ayarları başarıyla güncelleştirildi. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
ApiManagementPortalSettingsUpdateSignUp
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup?api-version=2022-08-01
{
"properties": {
"enabled": true,
"termsOfService": {
"enabled": true,
"text": "Terms of service text.",
"consentRequired": true
}
}
}
Sample Response
Tanımlar
Name | Description |
---|---|
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Portal |
Geliştirici portalının ayarlarını Sign-Up. |
Terms |
Hizmet sözleşmesi özellikleri. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilir gösterimi. |
PortalSignupSettings
Geliştirici portalının ayarlarını Sign-Up.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.enabled |
boolean |
Kullanıcıların bir geliştirici portalına kaydolmasına izin verin. |
properties.termsOfService |
Hizmet sözleşmesi özellikleri. |
|
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
TermsOfServiceProperties
Hizmet sözleşmesi özellikleri.
Name | Tür | Description |
---|---|---|
consentRequired |
boolean |
Kullanıcıdan hizmet koşullarına onay isteyin. |
enabled |
boolean |
Kayıt işlemi sırasında hizmet koşullarını görüntüleme. |
text |
string |
Hizmet koşulları metni. |