Tenant Access - Create

Gegevens van tenanttoegang bijwerken.

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

URI-parameters

Name In Required Type Description
accessName
path True

De id van de toegangsconfiguratie.

resourceGroupName
path True
  • string

De naam van de resourcegroep.

serviceName
path True
  • string

De naam van de API Management service.

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

subscriptionId
path True
  • string

Abonnementsreferenties die uw Microsoft Azure identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

api-version
query True
  • string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name Required Type Description
If-Match True
  • string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitstoestand van het header-antwoord van de GET-aanvraag, of moet * zijn voor onvoorwaardelijke updates.

Aanvraagbody

Name Type Description
properties.enabled
  • boolean

Hiermee bepaalt u of directe toegang is ingeschakeld.

properties.primaryKey
  • string

Primaire toegangssleutel. Deze eigenschap wordt niet ingevuld bij GET-bewerkingen. Gebruik de POST-aanvraag /listSecrets om de waarde op te halen.

properties.principalId
  • string

Principal-id (gebruiker).

properties.secondaryKey
  • string

Secundaire toegangssleutel. Deze eigenschap wordt niet ingevuld bij GET-bewerkingen. Gebruik de POST-aanvraag /listSecrets om de waarde op te halen.

Antwoorden

Name Type Description
200 OK

Informatie over tenanttoegang is bijgewerkt.

Headers

  • ETag: string
Other Status Codes

Foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

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 uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateTenantAccess

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access?api-version=2020-12-01
If-Match: *
{
  "properties": {
    "enabled": true
  }
}

Sample Response

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

Definities

AccessIdName

De id van de toegangsconfiguratie.

AccessInformationContract

Tenant Instellingen.

AccessInformationCreateParameters

Parameters voor het bijwerken van tenanttoegangsgegevens.

ErrorFieldContract

Foutveldcontract.

ErrorResponse

Foutreactie.

AccessIdName

De id van de toegangsconfiguratie.

Name Type Description
access
  • string
gitAccess
  • string

AccessInformationContract

Tenant Instellingen.

Name Type Description
id
  • string

Resource-id.

name
  • string

Resourcenaam.

properties.enabled
  • boolean

Hiermee bepaalt u of directe toegang is ingeschakeld.

properties.id
  • string

Type toegangsgegevens ('access' of 'gitAccess')

properties.principalId
  • string

Principal-id (gebruiker).

type
  • string

Resourcetype voor API Management resource.

AccessInformationCreateParameters

Parameters voor het bijwerken van tenanttoegangsgegevens.

Name Type Description
properties.enabled
  • boolean

Hiermee bepaalt u of directe toegang is ingeschakeld.

properties.primaryKey
  • string

Primaire toegangssleutel. Deze eigenschap wordt niet ingevuld bij GET-bewerkingen. Gebruik de POST-aanvraag /listSecrets om de waarde op te halen.

properties.principalId
  • string

Principal-id (gebruiker).

properties.secondaryKey
  • string

Secundaire toegangssleutel. Deze eigenschap wordt niet ingevuld bij GET-bewerkingen. Gebruik de POST-aanvraag /listSecrets om de waarde op te halen.

ErrorFieldContract

Foutveldcontract.

Name Type Description
code
  • string

Foutcode op eigenschapsniveau.

message
  • string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target
  • string

Eigenschapsnaam.

ErrorResponse

Foutreactie.

Name Type Description
error.code
  • string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

De lijst met ongeldige velden die in de aanvraag worden verzenden, in het geval van een validatiefout.

error.message
  • string

Door mensen leesbare weergave van de fout.