Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -3962,6 +3962,208 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials": {
"get": {
"tags": [
"credentials"
],
"operationId": "CredentialOperations_ListByFactory",
"x-ms-examples": {
"Credentials_ListByFactory": {
"$ref": "./examples/Credentials_ListByFactory.json"
}
},
"description": "List credentials.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/CredentialListResponse"
}
},
"default": {
"description": "An error response received from the Azure Data Factory service.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}": {
"put": {
"tags": [
"credentials"
],
"operationId": "CredentialOperations_CreateOrUpdate",
"x-ms-examples": {
"Credentials_Create": {
"$ref": "./examples/Credentials_Create.json"
}
},
"description": "Creates or updates a credential.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/credentialName"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "If-Match",
"in": "header",
"required": false,
"type": "string",
"description": "ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
},
{
"name": "credential",
"description": "Credential resource definition.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedIdentityCredentialResource"
}
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/ManagedIdentityCredentialResource"
}
},
"default": {
"description": "An error response received from PUT credential operation.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"credentials"
],
"operationId": "CredentialOperations_Get",
"x-ms-examples": {
"Credentials_Get": {
"$ref": "./examples/Credentials_Get.json"
}
},
"description": "Gets a credential.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/credentialName"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "If-None-Match",
"in": "header",
"required": false,
"type": "string",
"description": "ETag of the credential entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/ManagedIdentityCredentialResource"
}
},
"304": {
"description": "Not modified."
},
"default": {
"description": "An error response received from GET credential operation.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"delete": {
"tags": [
"credentials"
],
"operationId": "CredentialOperations_Delete",
"x-ms-examples": {
"Credentials_Delete": {
"$ref": "./examples/Credentials_Delete.json"
}
},
"description": "Deletes a credential.",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/credentialName"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "OK."
},
"204": {
"description": "No Content."
},
"default": {
"description": "An error response received from DELETE credential operation.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}": {
"put": {
"tags": [
Expand Down Expand Up @@ -7052,6 +7254,26 @@
}
}
},
"CredentialListResponse": {
"description": "A list of credential resources.",
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"description": "List of credentials.",
"items": {
"$ref": "#/definitions/ManagedIdentityCredentialResource"
}
},
"nextLink": {
"description": "The link to the next page of results, if any remaining results exist.",
"type": "string"
}
}
},
"ManagedPrivateEndpointResource": {
"description": "Managed private endpoint resource type.",
"allOf": [
Expand All @@ -7069,6 +7291,24 @@
"properties"
]
},
"ManagedIdentityCredentialResource": {
"description": "Credential resource type.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SubResource"
}
],
"properties": {
"properties": {
"$ref": "./entityTypes/Credential.json#/definitions/ManagedIdentityCredential",
"description": "Managed Identity Credential properties."
}
},
"required": [
"properties"
]
},
"ManagedVirtualNetworkListResponse": {
"description": "A list of managed Virtual Network resources.",
"type": "object",
Expand Down Expand Up @@ -7486,6 +7726,17 @@
"maxLength": 127,
"x-ms-parameter-location": "method"
},
"credentialName": {
"name": "credentialName",
"description": "Credential name",
"in": "path",
"required": true,
"type": "string",
"pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$",
"minLength": 1,
"maxLength": 127,
"x-ms-parameter-location": "method"
},
"managedPrivateEndpointName": {
"name": "managedPrivateEndpointName",
"description": "Managed private endpoint name",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"credentialName": "exampleCredential",
"ifMatch": null,
"credential": {
"properties": {
"type": "ManagedIdentity",
"typeProperties": {
"resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
}
}
},
"api-version": "2018-06-01"
},
"responses": {
"200": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:34 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-writes": "1196",
"x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de",
"x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de"
},
"body": {
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential",
"name": "exampleCredential",
"type": "Microsoft.DataFactory/factories/credentials",
"properties": {
"type": "ManagedIdentity",
"typeProperties": {
"resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
}
},
"etag": "0a0062d4-0000-0000-0000-5b245bcf0000"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"credentialName": "exampleCredential",
"api-version": "2018-06-01"
},
"responses": {
"200": {},
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"credentialName": "exampleCredential",
"ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000",
"api-version": "2018-06-01"
},
"responses": {
"304": {},
"200": {
"headers": {
"Date": "Mon, 22 Apr 2019 18:33:48 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-reads": "11995",
"x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c",
"x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c"
},
"body": {
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential",
"name": "exampleLinkedService",
"type": "Microsoft.DataFactory/factories/credentials",
"properties": {
"type": "ManagedIdentity",
"typeProperties": {
"resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
},
"description": "Example description"
},
"etag": "1500474f-0000-0200-0000-5cbe090d0000"
}
}
}
}
Loading