Tenant Access - Update

Service:

API Management

API-versie:

2024-05-01

Details van tenanttoegang bijwerken.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}?api-version=2024-05-01

URI-parameters

Name	In	Vereist	Type	Description
accessName	path	True	AccessIdName	De id van de Access-configuratie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.enabled	boolean	Bepaalt of directe toegang is ingeschakeld.

Antwoorden

Name	Type	Description
200 OK	AccessInformationContract	Tenanttoegangsgegevens zijn bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateTenantAccess

Voorbeeldaanvraag

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access?api-version=2024-05-01


{
  "properties": {
    "enabled": true
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access",
  "type": "Microsoft.ApiManagement/service/tenant",
  "name": "access",
  "properties": {
    "enabled": true
  }
}

Definities

Name	Description
AccessIdName	De id van de Access-configuratie.
AccessInformationContract	Tenantinstellingen.
AccessInformationUpdateParameters	Parameters voor het bijwerken van gegevens voor tenanttoegang.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

AccessIdName

Inventarisatie

De id van de Access-configuratie.

Waarde	Description
access
gitAccess

AccessInformationContract

Object

Tenantinstellingen.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.enabled	boolean	Bepaalt of directe toegang is ingeschakeld.
properties.id	string	Toegangsinformatietype ('access' of 'gitAccess')
properties.principalId	string	Principal-id (gebruiker).
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

AccessInformationUpdateParameters

Object

Parameters voor het bijwerken van gegevens voor tenanttoegang.

Name	Type	Description
properties.enabled	boolean	Bepaalt of directe toegang is ingeschakeld.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.