Tenant Access - Create

Update tenant access information details.

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

URI Parameters

Name In Required Type Description
accessName
path True

AccessIdName

The identifier of the Access configuration.

resourceGroupName
path True

string

The name of the resource group.

serviceName
path True

string

The name of the API Management service.

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

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

Request Header

Name Required Type Description
If-Match True

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name Type Description
properties.enabled

boolean

Determines whether direct access is enabled.

properties.primaryKey

string

Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

properties.principalId

string

Principal (User) Identifier.

properties.secondaryKey

string

Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Responses

Name Type Description
200 OK

AccessInformationContract

Tenant Access information was updated successfully.

Headers

ETag: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

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 impersonate your user account

Examples

ApiManagementCreateTenantAccess

Sample request

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


{
  "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
  }
}

Definitions

Name Description
AccessIdName

The identifier of the Access configuration.

AccessInformationContract

Tenant Settings.

AccessInformationCreateParameters

Tenant access information update parameters.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

AccessIdName

The identifier of the Access configuration.

Name Type Description
access

string

gitAccess

string

AccessInformationContract

Tenant Settings.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.enabled

boolean

Determines whether direct access is enabled.

properties.id

string

Access Information type ('access' or 'gitAccess')

properties.principalId

string

Principal (User) Identifier.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AccessInformationCreateParameters

Tenant access information update parameters.

Name Type Description
properties.enabled

boolean

Determines whether direct access is enabled.

properties.primaryKey

string

Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

properties.principalId

string

Principal (User) Identifier.

properties.secondaryKey

string

Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.